source: branches/samba-3.3.x/source/lib/ldb/man/ldbedit.1.xml

Last change on this file was 206, checked in by Herwig Bauernfeind, 16 years ago

Import Samba 3.3 branch at 3.0.0 level (psmedley's port)
File size: 4.9 KB
Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3<refentry id="ldbedit.1">
4
5 <refmeta>
6 <refentrytitle>ldbedit</refentrytitle>
7 <manvolnum>1</manvolnum>
8 </refmeta>
9
10
11 <refnamediv>
12 <refname>ldbedit</refname>
13 <refpurpose>Edit LDB databases using your preferred editor</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <cmdsynopsis>
18 <command>ldbedit</command>
19 <arg choice="opt">-?</arg>
20 <arg choice="opt">--usage</arg>
21 <arg choice="opt">-s base|one|sub</arg>
22 <arg choice="opt">-b basedn</arg>
23 <arg choice="opt">-a</arg>
24 <arg choice="opt">-e editor</arg>
25 <arg choice="opt">-H LDB-URL</arg>
26 <arg choice="opt">expression</arg>
27 <arg rep="repeat" choice="opt">attributes</arg>
28 </cmdsynopsis>
29</refsynopsisdiv>
30
31<refsect1>
32 <title>DESCRIPTION</title>
33
34 <para>ldbedit is a utility that allows you to edit LDB entries (in
35 tdb files, sqlite files or LDAP servers) using your preferred editor.
36 ldbedit generates an LDIF file based on your query, allows you to edit
37 the LDIF, and then merges that LDIF back into the LDB backend.
38 </para>
39
40</refsect1>
41
42
43 <refsect1>
44 <title>OPTIONS</title>
45
46 <variablelist>
47 <varlistentry>
48 <term>-?</term>
49 <term>--help</term>
50 <listitem>
51 <para>
52 Show list of available options, and a phrase describing what that option
53 does.
54 </para>
55 </listitem>
56 </varlistentry>
57
58 <varlistentry>
59 <term>--usage</term>
60 <listitem>
61 <para>
62 Show list of available options. This is similar to the help option,
63 however it does not provide any description, and is hence shorter.
64 </para>
65 </listitem>
66 </varlistentry>
67
68 <varlistentry>
69 <term>-H &lt;ldb-url&gt;</term>
70 <listitem>
71 <para>
72 LDB URL to connect to. For a tdb database,
73 this will be of the form
74 tdb://<replaceable>filename</replaceable>.
75 For a LDAP connection over unix domain
76 sockets, this will be of the form
77 ldapi://<replaceable>socket</replaceable>. For
78 a (potentially remote) LDAP connection over
79 TCP, this will be of the form
80 ldap://<replaceable>hostname</replaceable>. For
81 an SQLite database, this will be of the form
82 sqlite://<replaceable>filename</replaceable>.
83 </para>
84 </listitem>
85 </varlistentry>
86
87 <varlistentry>
88 <term>-s one|sub|base</term>
89 <listitem><para>Search scope to use. One-level, subtree or base.</para></listitem>
90 </varlistentry>
91
92 <varlistentry>
93 <term>-a</term>
94 <term>-all</term>
95 <listitem>
96 <para>Edit all records. This allows you to
97 apply the same change to a number of records
98 at once. You probably want to combine this
99 with an expression of the form
100 "objectclass=*".
101 </para>
102 </listitem>
103 </varlistentry>
104
105 <varlistentry>
106 <term>-e editor</term>
107 <term>--editor editor</term>
108 <listitem>
109 <para>Specify the editor that should be used (overrides
110 the VISUAL and EDITOR environment
111 variables). If this option is not used, and
112 neither VISUAL nor EDITOR environment variables
113 are set, then the vi editor will be used.
114 </para>
115 </listitem>
116 </varlistentry>
117
118 <varlistentry>
119 <term>-b basedn</term>
120 <listitem><para>Specify Base Distinguished Name to use.</para></listitem>
121 </varlistentry>
122
123 <varlistentry>
124 <term>-v</term>
125 <term>--verbose</term>
126 <listitem>
127 <para>Make ldbedit more verbose about the
128 operations that are being performed. Without
129 this option, ldbedit will only provide a
130 summary change line.
131 </para>
132 </listitem>
133 </varlistentry>
134
135 </variablelist>
136
137 </refsect1>
138
139 <refsect1>
140 <title>ENVIRONMENT</title>
141
142 <variablelist>
143 <varlistentry>
144 <term>LDB_URL</term>
145 <listitem>
146 <para>LDB URL to connect to. This can be
147 overridden by using the -H command-line option.)
148 </para>
149 </listitem>
150 </varlistentry>
151 <varlistentry>
152 <term>VISUAL and EDITOR</term>
153 <listitem>
154 <para>
155 Environment variables used to determine what
156 editor to use. VISUAL takes precedence over
157 EDITOR, and both are overridden by the
158 -e command-line option.
159 </para>
160 </listitem>
161 </varlistentry>
162 </variablelist>
163
164 </refsect1>
165
166 <refsect1>
167 <title>VERSION</title>
168
169 <para>This man page is correct for version 4.0 of the Samba suite.</para>
170 </refsect1>
171
172 <refsect1>
173 <title>SEE ALSO</title>
174
175 <para>ldb(7), ldbmodify(1), ldbdel(1), ldif(5), vi(1)</para>
176
177 </refsect1>
178
179 <refsect1>
180 <title>AUTHOR</title>
181
182 <para>
183 ldb was written by
184 <ulink url="http://samba.org/~tridge/">Andrew Tridgell</ulink>.
185 </para>
186
187 <para>
188 If you wish to report a problem or make a suggestion then please see
189 the <ulink url="http://ldb.samba.org/"/> web site for
190 current contact and maintainer information.
191 </para>
192
193 <para>
194 This manpage was written by Jelmer Vernooij and updated
195 by Brad Hards.
196 </para>
197
198 </refsect1>
199
200</refentry>
Note: See TracBrowser for help on using the repository browser.