0b5c63a17a87a2e435ae1da9bbba2f232624842a
[samba.git] / source / lib / ldb / man / ldbedit.1.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
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 favorite editor</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>ldbedit</command>
19                 <arg choice="opt">-h</arg>
20                 <arg choice="opt">-s base|one|sub</arg>
21                 <arg choice="opt">-b basedn</arg>
22                 <arg chioce="opt">-a</arg>
23                 <arg choice="opt">-e editor</arg>
24                 <arg choice="opt">-H LDB-URL</arg>
25                 <arg choice="opt">expression</arg>
26                 <arg choice="opt">attributes</arg>
27         </cmdsynopsis>
28 </refsynopsisdiv>
29
30 <refsect1>
31         <title>DESCRIPTION</title>
32
33         <para>ldbedit is a utility that allows you to edit LDB files using 
34                 your favorite editor. ldbedit generates an LDIF file based on 
35                 your query, allows you to edit it and then merges it back 
36                 into the LDB database.
37         </para>
38
39 </refsect1>
40
41
42 <refsect1>
43         <title>OPTIONS</title>
44
45         <variablelist>
46                 <varlistentry>
47                 <term>-h</term>
48                 <listitem><para>
49                 Show list of available options.</para></listitem>
50                 </varlistentry>
51
52                 <varlistentry>
53                         <term>-H &lt;ldb-url&gt;</term>
54                         <listitem><para>
55                                 LDB URL to connect to. See ldb(7) for details.
56                         </para></listitem>
57                 </varlistentry>
58
59                 <varlistentry>
60                         <term>-s one|sub|base</term>
61                         <listitem><para>Search scope to use. One-level, subtree or base.</para></listitem>
62                 </varlistentry>
63
64                 <varlistentry>
65                         <term>-a</term>
66                         <listitem><para>Edit all records. </para></listitem>
67                 </varlistentry>
68
69                 <varlistentry>
70                         <term>-e editor</term>
71                         <listitem><para>Specify the editor that should be used (overrides 
72                                         the VISUAL and EDITOR environment variables).</para></listitem>
73                 </varlistentry>
74
75                 <varlistentry>
76                         <term>-b basedn</term>
77                         <listitem><para>Specify Base DN to use.</para></listitem>
78                 </varlistentry>
79                 
80         </variablelist>
81         
82 </refsect1>
83
84 <refsect1>
85         <title>ENVIRONMENT</title>
86
87         <variablelist>
88                 <varlistentry><term>LDB_URL</term>
89                         <listitem><para>LDB URL to connect to (can be overrided by using the 
90                                         -H command-line option.)</para></listitem>
91                 </varlistentry>
92                 <varlistentry><term>VISUAL and EDITOR</term>
93                         <listitem><para>Environment variables used to determine what 
94                                         editor to use. If VISUAL isn't set, EDITOR is used. 
95                         </para></listitem>
96                 </varlistentry>
97         </variablelist>
98         
99 </refsect1>
100
101 <refsect1>
102         <title>VERSION</title>
103
104         <para>This man page is correct for version 4.0 of the Samba suite.</para>
105 </refsect1>
106
107 <refsect1>
108         <title>SEE ALSO</title>
109
110         <para>ldb(7), ldbmodify, ldbdel, ldif(5)</para>
111
112 </refsect1>
113
114 <refsect1>
115         <title>AUTHOR</title>
116
117         &man.credits.samba;
118
119         <para>ldbedit was written by Andrew Tridgell.</para>
120
121         <para>This manpage was written by Jelmer Vernooij.</para>
122         
123 </refsect1>
124
125 </refentry>