summaryrefslogtreecommitdiffstats
path: root/man/tdbtool.8.xml
blob: 045cbde73dd7d88c36a77c8ed35d49e69bf17554 (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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="tdbtool.8">
<refentryinfo><date>2015-04-25</date></refentryinfo>

<refmeta>
	<refentrytitle>tdbtool</refentrytitle>
	<manvolnum>8</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
	<refmiscinfo class="version">4.0</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>tdbtool</refname>
	<refpurpose>manipulate the contents TDB files</refpurpose>
</refnamediv>

<refsynopsisdiv>

	<cmdsynopsis>
		<command>tdbtool</command>
	</cmdsynopsis>

	<cmdsynopsis>
		<command>tdbtool</command>
		<arg choice="opt">-l</arg>
		<arg choice="plain">
		<replaceable>TDBFILE</replaceable>
		</arg>
		<arg rep="repeat" choice="opt">
		<replaceable>COMMANDS</replaceable>
		</arg>
	</cmdsynopsis>

</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the
	<citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry> suite.</para>

	<para><command>tdbtool</command> a tool for displaying and
	altering the contents of Samba TDB (Trivial DataBase) files. Each
	of the commands listed below can be entered interactively or
	provided on the command line.</para>

</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>

		<varlistentry>
		<term>-l</term>
		<listitem><para>
		This options disables any locking, by passing TDB_NOLOCK
		to tdb_open_ex(). Only use this for database files which
		are not used by any other process! And also only if it is otherwise not
		possible to open the database, e.g. databases which were created with
		mutex locking.
		</para></listitem>
		</varlistentry>

	</variablelist>
</refsect1>



<refsect1>
	<title>COMMANDS</title>

	<variablelist>

		<varlistentry>
		<term><option>create</option>
		<replaceable>TDBFILE</replaceable></term>
		<listitem><para>Create a new database named
		<replaceable>TDBFILE</replaceable>.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>open</option>
		<replaceable>TDBFILE</replaceable></term>
		<listitem><para>Open an existing database named
		<replaceable>TDBFILE</replaceable>.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>erase</option></term>
		<listitem><para>Erase the current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>dump</option></term>
		<listitem><para>Dump the current database as strings.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>cdump</option></term>
		<listitem><para>Dump the current database as connection records.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>keys</option></term>
		<listitem><para>Dump the current database keys as strings.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>hexkeys</option></term>
		<listitem><para>Dump the current database keys as hex values.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>info</option></term>
		<listitem><para>Print summary information about the
		current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>insert</option>
		<replaceable>KEY</replaceable>
		<replaceable>DATA</replaceable>
		</term>
		<listitem><para>Insert a record into the
		current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>move</option>
		<replaceable>KEY</replaceable>
		<replaceable>TDBFILE</replaceable>
		</term>
		<listitem><para>Move a record from the
		current database into <replaceable>TDBFILE</replaceable>.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>store</option>
		<replaceable>KEY</replaceable>
		<replaceable>DATA</replaceable>
		</term>
		<listitem><para>Store (replace) a record in the
		current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>storehex</option>
		<replaceable>KEY</replaceable>
		<replaceable>DATA</replaceable>
		</term>
		<listitem><para>Store (replace) a record in the
		current database where key and data are in hex format.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>show</option>
		<replaceable>KEY</replaceable>
		</term>
		<listitem><para>Show a record by key.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>delete</option>
		<replaceable>KEY</replaceable>
		</term>
		<listitem><para>Delete a record by key.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>list</option>
		</term>
		<listitem><para>Print the current database hash table and free list.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>free</option>
		</term>
		<listitem><para>Print the current database and free list.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><option>!</option>
		<replaceable>COMMAND</replaceable>
		</term>
		<listitem><para>Execute the given system command.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>
		<option>first</option>
		</term>
		<listitem><para>Print the first record in the current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>
		<option>next</option>
		</term>
		<listitem><para>Print the next record in the current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>
		<option>check</option>
		</term>
		<listitem><para>Check the integrity of the current database.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>
		<option>repack</option>
		</term>
		<listitem><para>Repack a database using a temporary file to remove fragmentation.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>
		<option>quit</option>
		</term>
		<listitem><para>Exit <command>tdbtool</command>.
		</para></listitem>
		</varlistentry>

	</variablelist>
</refsect1>

<refsect1>
	<title>CAVEATS</title>
	<para>The contents of the Samba TDB files are private
	to the implementation and should not be altered with
	<command>tdbtool</command>.
	</para>
</refsect1>

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

<refsect1>
	<title>AUTHOR</title>

	<para> The original Samba software and related utilities were
	created by Andrew Tridgell.  Samba is now developed by the
	Samba Team as an Open Source project similar to the way the
	Linux kernel is developed.</para>
</refsect1>

</refentry>