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