lib/tdb/man/tdbtool.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="tdbtool.8">
   4 <refentryinfo><date>2015-04-25</date></refentryinfo>
   5
   6 <refmeta>
   7         <refentrytitle>tdbtool</refentrytitle>
   8         <manvolnum>8</manvolnum>
   9         <refmiscinfo class="source">Samba</refmiscinfo>
  10         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  11         <refmiscinfo class="version">4.0</refmiscinfo>
  12 </refmeta>
  13
  14
  15 <refnamediv>
  16         <refname>tdbtool</refname>
  17         <refpurpose>manipulate the contents TDB files</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21
  22         <cmdsynopsis>
  23                 <command>tdbtool</command>
  24         </cmdsynopsis>
  25
  26         <cmdsynopsis>
  27                 <command>tdbtool</command>
  28                 <arg choice="opt">-l</arg>
  29                 <arg choice="plain">
  30                 <replaceable>TDBFILE</replaceable>
  31                 </arg>
  32                 <arg rep="repeat" choice="opt">
  33                 <replaceable>COMMANDS</replaceable>
  34                 </arg>
  35         </cmdsynopsis>
  36
  37 </refsynopsisdiv>
  38
  39 <refsect1>
  40         <title>DESCRIPTION</title>
  41
  42         <para>This tool is part of the
  43         <citerefentry><refentrytitle>samba</refentrytitle>
  44         <manvolnum>1</manvolnum></citerefentry> suite.</para>
  45
  46         <para><command>tdbtool</command> a tool for displaying and
  47         altering the contents of Samba TDB (Trivial DataBase) files. Each
  48         of the commands listed below can be entered interactively or
  49         provided on the command line.</para>
  50
  51 </refsect1>
  52
  53 <refsect1>
  54         <title>OPTIONS</title>
  55
  56         <variablelist>
  57
  58                 <varlistentry>
  59                 <term>-l</term>
  60                 <listitem><para>
  61                 This options disables any locking, by passing TDB_NOLOCK
  62                 to tdb_open_ex(). Only use this for database files which
  63                 are not used by any other process! And also only if it is otherwise not
  64                 possible to open the database, e.g. databases which were created with
  65                 mutex locking.
  66                 </para></listitem>
  67                 </varlistentry>
  68
  69         </variablelist>
  70 </refsect1>
  71
  72
  73
  74 <refsect1>
  75         <title>COMMANDS</title>
  76
  77         <variablelist>
  78
  79                 <varlistentry>
  80                 <term><option>create</option>
  81                 <replaceable>TDBFILE</replaceable></term>
  82                 <listitem><para>Create a new database named
  83                 <replaceable>TDBFILE</replaceable>.
  84                 </para></listitem>
  85                 </varlistentry>
  86
  87                 <varlistentry>
  88                 <term><option>open</option>
  89                 <replaceable>TDBFILE</replaceable></term>
  90                 <listitem><para>Open an existing database named
  91                 <replaceable>TDBFILE</replaceable>.
  92                 </para></listitem>
  93                 </varlistentry>
  94
  95                 <varlistentry>
  96                 <term><option>erase</option></term>
  97                 <listitem><para>Erase the current database.
  98                 </para></listitem>
  99                 </varlistentry>
 100
 101                 <varlistentry>
 102                 <term><option>dump</option></term>
 103                 <listitem><para>Dump the current database as strings.
 104                 </para></listitem>
 105                 </varlistentry>
 106
 107                 <varlistentry>
 108                 <term><option>cdump</option></term>
 109                 <listitem><para>Dump the current database as connection records.
 110                 </para></listitem>
 111                 </varlistentry>
 112
 113                 <varlistentry>
 114                 <term><option>keys</option></term>
 115                 <listitem><para>Dump the current database keys as strings.
 116                 </para></listitem>
 117                 </varlistentry>
 118
 119                 <varlistentry>
 120                 <term><option>hexkeys</option></term>
 121                 <listitem><para>Dump the current database keys as hex values.
 122                 </para></listitem>
 123                 </varlistentry>
 124
 125                 <varlistentry>
 126                 <term><option>info</option></term>
 127                 <listitem><para>Print summary information about the
 128                 current database.
 129                 </para></listitem>
 130                 </varlistentry>
 131
 132                 <varlistentry>
 133                 <term><option>insert</option>
 134                 <replaceable>KEY</replaceable>
 135                 <replaceable>DATA</replaceable>
 136                 </term>
 137                 <listitem><para>Insert a record into the
 138                 current database.
 139                 </para></listitem>
 140                 </varlistentry>
 141
 142                 <varlistentry>
 143                 <term><option>move</option>
 144                 <replaceable>KEY</replaceable>
 145                 <replaceable>TDBFILE</replaceable>
 146                 </term>
 147                 <listitem><para>Move a record from the
 148                 current database into <replaceable>TDBFILE</replaceable>.
 149                 </para></listitem>
 150                 </varlistentry>
 151
 152                 <varlistentry>
 153                 <term><option>store</option>
 154                 <replaceable>KEY</replaceable>
 155                 <replaceable>DATA</replaceable>
 156                 </term>
 157                 <listitem><para>Store (replace) a record in the
 158                 current database.
 159                 </para></listitem>
 160                 </varlistentry>
 161
 162                 <varlistentry>
 163                 <term><option>show</option>
 164                 <replaceable>KEY</replaceable>
 165                 </term>
 166                 <listitem><para>Show a record by key.
 167                 </para></listitem>
 168                 </varlistentry>
 169
 170                 <varlistentry>
 171                 <term><option>delete</option>
 172                 <replaceable>KEY</replaceable>
 173                 </term>
 174                 <listitem><para>Delete a record by key.
 175                 </para></listitem>
 176                 </varlistentry>
 177
 178                 <varlistentry>
 179                 <term><option>list</option>
 180                 </term>
 181                 <listitem><para>Print the current database hash table and free list.
 182                 </para></listitem>
 183                 </varlistentry>
 184
 185                 <varlistentry>
 186                 <term><option>free</option>
 187                 </term>
 188                 <listitem><para>Print the current database and free list.
 189                 </para></listitem>
 190                 </varlistentry>
 191
 192                 <varlistentry>
 193                 <term><option>!</option>
 194                 <replaceable>COMMAND</replaceable>
 195                 </term>
 196                 <listitem><para>Execute the given system command.
 197                 </para></listitem>
 198                 </varlistentry>
 199
 200                 <varlistentry>
 201                 <term>
 202                 <option>first</option>
 203                 </term>
 204                 <listitem><para>Print the first record in the current database.
 205                 </para></listitem>
 206                 </varlistentry>
 207
 208                 <varlistentry>
 209                 <term>
 210                 <option>next</option>
 211                 </term>
 212                 <listitem><para>Print the next record in the current database.
 213                 </para></listitem>
 214                 </varlistentry>
 215
 216                 <varlistentry>
 217                 <term>
 218                 <option>check</option>
 219                 </term>
 220                 <listitem><para>Check the integrity of the current database.
 221                 </para></listitem>
 222                 </varlistentry>
 223
 224                 <varlistentry>
 225                 <term>
 226                 <option>repack</option>
 227                 </term>
 228                 <listitem><para>Repack a database using a temporary file to remove fragmentation.
 229                 </para></listitem>
 230                 </varlistentry>
 231
 232                 <varlistentry>
 233                 <term>
 234                 <option>quit</option>
 235                 </term>
 236                 <listitem><para>Exit <command>tdbtool</command>.
 237                 </para></listitem>
 238                 </varlistentry>
 239
 240         </variablelist>
 241 </refsect1>
 242
 243 <refsect1>
 244         <title>CAVEATS</title>
 245         <para>The contents of the Samba TDB files are private
 246         to the implementation and should not be altered with
 247         <command>tdbtool</command>.
 248         </para>
 249 </refsect1>
 250
 251 <refsect1>
 252         <title>VERSION</title>
 253         <para>This man page is correct for version 3.6 of the Samba suite.</para>
 254 </refsect1>
 255
 256 <refsect1>
 257         <title>AUTHOR</title>
 258
 259         <para> The original Samba software and related utilities were
 260         created by Andrew Tridgell.  Samba is now developed by the
 261         Samba Team as an Open Source project similar to the way the
 262         Linux kernel is developed.</para>
 263 </refsect1>
 264
 265 </refentry>