summaryrefslogtreecommitdiff
path: root/source4/lib/ldb/man/ldbedit.1.xml
blob: 3cfcce89f1b0cf6fec5b4825a5611b5c217f694e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="ldbedit.1">

    <refmeta>
	<refentrytitle>ldbedit</refentrytitle>
	<manvolnum>1</manvolnum>
    </refmeta>


    <refnamediv>
	<refname>ldbedit</refname>
	<refpurpose>Edit LDB databases using your preferred editor</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
	<cmdsynopsis>
	    <command>ldbedit</command>
	    <arg choice="opt">-?</arg>
	    <arg choice="opt">--usage</arg>
	    <arg choice="opt">-s base|one|sub</arg>
	    <arg choice="opt">-b basedn</arg>
	    <arg choice="opt">-a</arg>
	    <arg choice="opt">-e editor</arg>
	    <arg choice="opt">-H LDB-URL</arg>
	    <arg choice="opt">expression</arg>
	    <arg rep="repeat" choice="opt">attributes</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>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.
	</para>

</refsect1>


    <refsect1>
	<title>OPTIONS</title>
	
	<variablelist>
	    <varlistentry>
		<term>-?</term>
		<term>--help</term>
		<listitem>
		    <para>
			Show list of available options, and a phrase describing what that option
			does.
		    </para>
		</listitem>
	    </varlistentry>

	    <varlistentry>
		<term>--usage</term>
		<listitem>
		    <para>
			Show list of available options. This is similar to the help option, 
			however it does not provide any description, and is hence shorter.
		    </para>
		</listitem>
	    </varlistentry>

	    <varlistentry>
		<term>-H &lt;ldb-url&gt;</term>
		<listitem>
		    <para>
			LDB URL to connect to. For a tdb database,
			this will be of the form
			tdb://<replaceable>filename</replaceable>.
			For a LDAP connection over unix domain
			sockets, this will be of the form
			ldapi://<replaceable>socket</replaceable>. For
			a (potentially remote) LDAP connection over
			TCP, this will be of the form
			ldap://<replaceable>hostname</replaceable>. For
			an SQLite database, this will be of the form
			sqlite://<replaceable>filename</replaceable>.
		    </para>
		</listitem>
	    </varlistentry>

	    <varlistentry>
		<term>-s one|sub|base</term>
		<listitem><para>Search scope to use. One-level, subtree or base.</para></listitem>
	    </varlistentry>

	    <varlistentry>
		<term>-a</term>
		<term>-all</term>
		<listitem>
		    <para>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=*".
		    </para>
		</listitem>
	    </varlistentry>

	    <varlistentry>
		<term>-e editor</term>
		<term>--editor editor</term>
		<listitem>
		    <para>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.
		    </para>
		</listitem>
	    </varlistentry>

	    <varlistentry>
		<term>-b basedn</term>
		<listitem><para>Specify Base Distinguished Name to use.</para></listitem>
	    </varlistentry>

	    <varlistentry>
		<term>-v</term>
		<term>--verbose</term>
		<listitem>
		    <para>Make ldbedit more verbose about the
			operations that are being performed. Without
			this option, ldbedit will only provide a
			summary change line.
		    </para>
		</listitem>
	    </varlistentry>
		
	</variablelist>
	
    </refsect1>

    <refsect1>
	<title>ENVIRONMENT</title>

	<variablelist>
	    <varlistentry>
		<term>LDB_URL</term>
		<listitem>
		    <para>LDB URL to connect to. This can be
		    overridden by using the -H command-line option.)
		    </para>
		</listitem>
	    </varlistentry>
	    <varlistentry>
		<term>VISUAL and EDITOR</term>
		<listitem>
		    <para>
			Environment variables used to determine what 
			editor to use. VISUAL takes precedence over
			EDITOR, and both are overridden by the
			-e command-line option.
		    </para>
		</listitem>
	    </varlistentry>
	</variablelist>
	
    </refsect1>

    <refsect1>
	<title>VERSION</title>
	
	<para>This man page is correct for version 4.0 of the Samba suite.</para>
    </refsect1>

    <refsect1>
	<title>SEE ALSO</title>
	
	<para>ldb(7), ldbmodify(1), ldbdel(1), ldif(5), vi(1)</para>

    </refsect1>

    <refsect1>
	<title>AUTHOR</title>

	<para>
	    ldb was written by 
	    <ulink url="http://samba.org/~tridge/">Andrew Tridgell</ulink>.
	</para>

	<para>
	    If you wish to report a problem or make a suggestion then please see
	    the <ulink url="http://ldb.samba.org/"/> web site for
	    current contact and maintainer information.
	</para>

	<para>
	    This manpage was written by Jelmer Vernooij and updated
	    by Brad Hards.
	</para>
	
    </refsect1>

</refentry>