VERSION: Bump version to 3.6.0pre1.
[Samba/gbeck.git] / docs-xml / manpages-3 / tdbtool.8.xml
blob9f96db277dbbec46f0e9ebc3ea9a2ff66b62c810
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="tdbtool.8">
5 <refmeta>
6         <refentrytitle>tdbtool</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.6</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>tdbtool</refname>
16         <refpurpose>manipulate the contents TDB files</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>tdbtool</command>
23         </cmdsynopsis>
25         <cmdsynopsis>
26                 <command>tdbtool</command>
27                 <arg choice="plain">
28                 <replaceable>TDBFILE</replaceable>
29                 </arg>
30                 <arg rep="repeat" choice="opt">
31                 <replaceable>COMMANDS</replaceable>
32                 </arg>
33         </cmdsynopsis>
35 </refsynopsisdiv>
37 <refsect1>
38         <title>DESCRIPTION</title>
40         <para>This tool is part of the
41         <citerefentry><refentrytitle>samba</refentrytitle>
42         <manvolnum>1</manvolnum></citerefentry> suite.</para>
44         <para><command>tdbtool</command> a tool for displaying and
45         altering the contents of Samba TDB (Trivial DataBase) files. Each
46         of the commands listed below can be entered interactively or
47         provided on the command line.</para>
49 </refsect1>
52 <refsect1>
53         <title>COMMANDS</title>
55         <variablelist>
57                 <varlistentry>
58                 <term><option>create</option>
59                 <replaceable>TDBFILE</replaceable></term>
60                 <listitem><para>Create a new database named
61                 <replaceable>TDBFILE</replaceable>.
62                 </para></listitem>
63                 </varlistentry>
65                 <varlistentry>
66                 <term><option>open</option>
67                 <replaceable>TDBFILE</replaceable></term>
68                 <listitem><para>Open an existing database named
69                 <replaceable>TDBFILE</replaceable>.
70                 </para></listitem>
71                 </varlistentry>
73                 <varlistentry>
74                 <term><option>erase</option></term>
75                 <listitem><para>Erase the current database.
76                 </para></listitem>
77                 </varlistentry>
79                 <varlistentry>
80                 <term><option>dump</option></term>
81                 <listitem><para>Dump the current database as strings.
82                 </para></listitem>
83                 </varlistentry>
85                 <varlistentry>
86                 <term><option>cdump</option></term>
87                 <listitem><para>Dump the current database as connection records.
88                 </para></listitem>
89                 </varlistentry>
91                 <varlistentry>
92                 <term><option>keys</option></term>
93                 <listitem><para>Dump the current database keys as strings.
94                 </para></listitem>
95                 </varlistentry>
97                 <varlistentry>
98                 <term><option>hexkeys</option></term>
99                 <listitem><para>Dump the current database keys as hex values.
100                 </para></listitem>
101                 </varlistentry>
103                 <varlistentry>
104                 <term><option>info</option></term>
105                 <listitem><para>Print summary information about the
106                 current database.
107                 </para></listitem>
108                 </varlistentry>
110                 <varlistentry>
111                 <term><option>insert</option>
112                 <replaceable>KEY</replaceable>
113                 <replaceable>DATA</replaceable>
114                 </term>
115                 <listitem><para>Insert a record into the
116                 current database.
117                 </para></listitem>
118                 </varlistentry>
120                 <varlistentry>
121                 <term><option>move</option>
122                 <replaceable>KEY</replaceable>
123                 <replaceable>TDBFILE</replaceable>
124                 </term>
125                 <listitem><para>Move a record from the 
126                 current database into <replaceable>TDBFILE</replaceable>.
127                 </para></listitem>
128                 </varlistentry>
130                 <varlistentry>
131                 <term><option>store</option>
132                 <replaceable>KEY</replaceable>
133                 <replaceable>DATA</replaceable>
134                 </term>
135                 <listitem><para>Store (replace) a record in the
136                 current database.
137                 </para></listitem>
138                 </varlistentry>
140                 <varlistentry>
141                 <term><option>show</option>
142                 <replaceable>KEY</replaceable>
143                 </term>
144                 <listitem><para>Show a record by key.
145                 </para></listitem>
146                 </varlistentry>
148                 <varlistentry>
149                 <term><option>delete</option>
150                 <replaceable>KEY</replaceable>
151                 </term>
152                 <listitem><para>Delete a record by key.
153                 </para></listitem>
154                 </varlistentry>
156                 <varlistentry>
157                 <term><option>list</option>
158                 </term>
159                 <listitem><para>Print the current database hash table and free list.
160                 </para></listitem>
161                 </varlistentry>
163                 <varlistentry>
164                 <term><option>free</option>
165                 </term>
166                 <listitem><para>Print the current database and free list.
167                 </para></listitem>
168                 </varlistentry>
170                 <varlistentry>
171                 <term><option>!</option>
172                 <replaceable>COMMAND</replaceable>
173                 </term>
174                 <listitem><para>Execute the given system command.
175                 </para></listitem>
176                 </varlistentry>
178                 <varlistentry>
179                 <term>
180                 <option>first</option>
181                 </term>
182                 <listitem><para>Print the first record in the current database.
183                 </para></listitem>
184                 </varlistentry>
186                 <varlistentry>
187                 <term>
188                 <option>next</option>
189                 </term>
190                 <listitem><para>Print the next record in the current database.
191                 </para></listitem>
192                 </varlistentry>
194                 <varlistentry>
195                 <term>
196                 <option>check</option>
197                 </term>
198                 <listitem><para>Check the integrity of the current database.
199                 </para></listitem>
200                 </varlistentry>
202                 <varlistentry>
203                 <term>
204                 <option>quit</option>
205                 </term>
206                 <listitem><para>Exit <command>tdbtool</command>.
207                 </para></listitem>
208                 </varlistentry>
210         </variablelist>
211 </refsect1>
213 <refsect1>
214         <title>CAVEATS</title>
215         <para>The contents of the Samba TDB files are private
216         to the implementation and should not be altered with
217         <command>tdbtool</command>.
218         </para>
219 </refsect1>
221 <refsect1>
222         <title>VERSION</title>
223         <para>This man page is correct for version 3.0.25 of the Samba suite.</para>
224 </refsect1>
226 <refsect1>
227         <title>AUTHOR</title>
229         <para> The original Samba software and related utilities were
230         created by Andrew Tridgell.  Samba is now developed by the
231         Samba Team as an Open Source project similar to the way the
232         Linux kernel is developed.</para>
233 </refsect1>
235 </refentry>