source: branches/samba-3.3.x/docs/htmldocs/manpages/ldbedit.1.html@ 274

Last change on this file since 274 was 218, checked in by Herwig Bauernfeind, 17 years ago

Import Samba 3.3 branch at 3.3.0 level docs htmldocs (psmedley's port)

File size: 4.5 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ldbedit</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ldbedit.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ldbedit &#8212; Edit LDB databases using your preferred editor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">ldbedit</code> [-?] [--usage] [-s base|one|sub] [-b basedn] [-a] [-e editor] [-H LDB-URL] [expression] [attributes...]</p></div></div><div class="refsect1" lang="en"><a name="id2483370"></a><h2>DESCRIPTION</h2><p>ldbedit is a utility that allows you to edit LDB entries (in
2 tdb files, sqlite files or LDAP servers) using your preferred editor.
3 ldbedit generates an LDIF file based on your query, allows you to edit
4 the LDIF, and then merges that LDIF back into the LDB backend.
5 </p></div><div class="refsect1" lang="en"><a name="id2483385"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-?, </span><span class="term">--help</span></dt><dd><p>
6 Show list of available options, and a phrase describing what that option
7 does.
8 </p></dd><dt><span class="term">--usage</span></dt><dd><p>
9 Show list of available options. This is similar to the help option,
10 however it does not provide any description, and is hence shorter.
11 </p></dd><dt><span class="term">-H &lt;ldb-url&gt;</span></dt><dd><p>
12 LDB URL to connect to. For a tdb database,
13 this will be of the form
14 tdb://<em class="replaceable"><code>filename</code></em>.
15 For a LDAP connection over unix domain
16 sockets, this will be of the form
17 ldapi://<em class="replaceable"><code>socket</code></em>. For
18 a (potentially remote) LDAP connection over
19 TCP, this will be of the form
20 ldap://<em class="replaceable"><code>hostname</code></em>. For
21 an SQLite database, this will be of the form
22 sqlite://<em class="replaceable"><code>filename</code></em>.
23 </p></dd><dt><span class="term">-s one|sub|base</span></dt><dd><p>Search scope to use. One-level, subtree or base.</p></dd><dt><span class="term">-a, </span><span class="term">-all</span></dt><dd><p>Edit all records. This allows you to
24 apply the same change to a number of records
25 at once. You probably want to combine this
26 with an expression of the form
27 "objectclass=*".
28 </p></dd><dt><span class="term">-e editor, </span><span class="term">--editor editor</span></dt><dd><p>Specify the editor that should be used (overrides
29 the VISUAL and EDITOR environment
30 variables). If this option is not used, and
31 neither VISUAL nor EDITOR environment variables
32 are set, then the vi editor will be used.
33 </p></dd><dt><span class="term">-b basedn</span></dt><dd><p>Specify Base Distinguished Name to use.</p></dd><dt><span class="term">-v, </span><span class="term">--verbose</span></dt><dd><p>Make ldbedit more verbose about the
34 operations that are being performed. Without
35 this option, ldbedit will only provide a
36 summary change line.
37 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2483662"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term">LDB_URL</span></dt><dd><p>LDB URL to connect to. This can be