tdb: Add tdbdump -u
[samba.git] / lib / tdb / man / tdbdump.8.xml
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="tdbdump.8">
4 <refentryinfo><date>2015-04-25</date></refentryinfo>
5
6 <refmeta>
7         <refentrytitle>tdbdump</refentrytitle>
8         <manvolnum>8</manvolnum>
9         <refmiscinfo class="source">Samba</refmiscinfo>
10         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
11         <refmiscinfo class="version">3.6</refmiscinfo>
12 </refmeta>
13
14
15 <refnamediv>
16         <refname>tdbdump</refname>
17         <refpurpose>tool for printing the contents of a TDB file</refpurpose>
18 </refnamediv>
19
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>tdbdump</command>
23                 <arg choice="opt">-k <replaceable>keyname</replaceable></arg>
24                 <arg choice="opt">-e</arg>
25                 <arg choice="opt">-u</arg>
26                 <arg choice="opt">-h</arg>
27                 <arg choice="req">filename</arg>
28         </cmdsynopsis>
29 </refsynopsisdiv>
30
31 <refsect1>
32         <title>DESCRIPTION</title>
33
34         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
35         <manvolnum>1</manvolnum></citerefentry> suite.</para>
36
37         <para><command>tdbdump</command> is a very simple utility that 'dumps' the
38                 contents of a TDB (Trivial DataBase) file to standard output in a
39                 human-readable format.
40         </para>
41
42         <para>This tool can be used when debugging problems with TDB files. It is
43                 intended for those who are somewhat familiar with Samba internals.
44         </para>
45 </refsect1>
46
47 <refsect1>
48         <title>OPTIONS</title>
49
50         <variablelist>
51
52                 <varlistentry>
53                 <term>-h</term>
54                 <listitem><para>
55                 Get help information.
56                 </para></listitem>
57                 </varlistentry>
58
59                 <varlistentry>
60                 <term>-k <replaceable>keyname</replaceable></term>
61                 <listitem><para>
62                 The <command>-k</command> option restricts dumping to a single key, if found.
63                 </para> </listitem>
64                 </varlistentry>
65
66                 <varlistentry>
67                 <term>-e</term>
68                 <listitem><para>
69                 The <command>-e</command> tries to dump out from a corrupt database.  Naturally, such a dump is unreliable, at best.
70                 </para></listitem>
71                 </varlistentry>
72
73                 <varlistentry>
74                 <term>-u</term>
75                 <listitem><para>
76                   'Undumps' a database, turning the tdbdump output on stdin
77                   into a tdb again.
78                 </para></listitem>
79                 </varlistentry>
80
81         </variablelist>
82 </refsect1>
83
84 <refsect1>
85         <title>VERSION</title>
86
87         <para>This man page is correct for version 3 of the Samba suite.</para>
88 </refsect1>
89
90 <refsect1>
91         <title>AUTHOR</title>
92
93         <para>
94         The original Samba software and related utilities were created by Andrew Tridgell.
95         Samba is now developed by the Samba Team as an Open Source project similar to the way
96         the Linux kernel is developed.
97         </para>
98
99         <para>The tdbdump man page was written by Jelmer Vernooij.</para>
100 </refsect1>
101
102 </refentry>