From 90c0e75df749f072731e2541354cc89f25dee219 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Wed, 5 Sep 2012 20:46:05 +0200 Subject: [PATCH] docs: Remove old ldb manpages. The ldb manpages can be found in lib/ldb/man/. --- docs-xml/manpages/ldb.3.xml | 265 -------------------------------------- docs-xml/manpages/ldbadd.1.xml | 108 ---------------- docs-xml/manpages/ldbdel.1.xml | 108 ---------------- docs-xml/manpages/ldbedit.1.xml | 203 ----------------------------- docs-xml/manpages/ldbmodify.1.xml | 96 -------------- docs-xml/manpages/ldbrename.1.xml | 110 ---------------- docs-xml/manpages/ldbsearch.1.xml | 122 ------------------ 7 files changed, 1012 deletions(-) delete mode 100644 docs-xml/manpages/ldb.3.xml delete mode 100644 docs-xml/manpages/ldbadd.1.xml delete mode 100644 docs-xml/manpages/ldbdel.1.xml delete mode 100644 docs-xml/manpages/ldbedit.1.xml delete mode 100644 docs-xml/manpages/ldbmodify.1.xml delete mode 100644 docs-xml/manpages/ldbrename.1.xml delete mode 100644 docs-xml/manpages/ldbsearch.1.xml diff --git a/docs-xml/manpages/ldb.3.xml b/docs-xml/manpages/ldb.3.xml deleted file mode 100644 index 715fd8002fb..00000000000 --- a/docs-xml/manpages/ldb.3.xml +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - ldb - 3 - Samba - C Library Functions - 3.6 - - - - 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. - - - -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 -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 - - - - - - Author - - - 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/docs-xml/manpages/ldbadd.1.xml b/docs-xml/manpages/ldbadd.1.xml deleted file mode 100644 index b0c25e74c77..00000000000 --- a/docs-xml/manpages/ldbadd.1.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - ldbadd - 1 - Samba - User Commands - 3.6 - - - - - 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 overridden 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 - - 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. - - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/docs-xml/manpages/ldbdel.1.xml b/docs-xml/manpages/ldbdel.1.xml deleted file mode 100644 index c7e33a839ff..00000000000 --- a/docs-xml/manpages/ldbdel.1.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - ldbdel - 1 - Samba - User Commands - 3.6 - - - - - 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 overridden 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 - - 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. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/docs-xml/manpages/ldbedit.1.xml b/docs-xml/manpages/ldbedit.1.xml deleted file mode 100644 index bbca0d23095..00000000000 --- a/docs-xml/manpages/ldbedit.1.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - ldbedit - 1 - Samba - User Commands - 3.6 - - - - - ldbedit - Edit LDB databases using your preferred editor - - - - - 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 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 - - - - -? - --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. 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) - - - - - AUTHOR - - - 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. - - - - This manpage was written by Jelmer Vernooij and updated - by Brad Hards. - - - - - diff --git a/docs-xml/manpages/ldbmodify.1.xml b/docs-xml/manpages/ldbmodify.1.xml deleted file mode 100644 index 0c91f755999..00000000000 --- a/docs-xml/manpages/ldbmodify.1.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - ldbmodify - 1 - Samba - User Commands - 3.6 - - - - - 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 overridden 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 - - 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. - - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/docs-xml/manpages/ldbrename.1.xml b/docs-xml/manpages/ldbrename.1.xml deleted file mode 100644 index 394cff74ef6..00000000000 --- a/docs-xml/manpages/ldbrename.1.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - ldbrename - 1 - Samba - User Commands - 3.6 - - - - - 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 overridden 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 - - 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. - - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/docs-xml/manpages/ldbsearch.1.xml b/docs-xml/manpages/ldbsearch.1.xml deleted file mode 100644 index 6882c56bfe4..00000000000 --- a/docs-xml/manpages/ldbsearch.1.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - ldbsearch - 1 - Samba - User Commands - 3.6 - - - - - 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 overridden 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(1) - - - - - AUTHOR - - 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. - - - This manpage was written by Jelmer Vernooij. - - - - -- 2.11.4.GIT