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 +++++++++++++++++++++++++------------- source4/lib/ldb/tools/ldbedit.c | 2 +- 2 files changed, 151 insertions(+), 82 deletions(-) (limited to 'source4/lib/ldb') 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. + - + diff --git a/source4/lib/ldb/tools/ldbedit.c b/source4/lib/ldb/tools/ldbedit.c index 570179c2e1..4d47cf27c9 100644 --- a/source4/lib/ldb/tools/ldbedit.c +++ b/source4/lib/ldb/tools/ldbedit.c @@ -274,7 +274,7 @@ static void usage(void) printf(" -b basedn choose baseDN\n"); printf(" -a edit all records (expression 'objectclass=*')\n"); printf(" -e editor choose editor (or $VISUAL or $EDITOR)\n"); - printf(" -v verbose mode)\n"); + printf(" -v verbose mode\n"); exit(1); } -- cgit