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