docs/manpages-3/tdbtool.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="tdbtool.8">
   4
   5 <refmeta>
   6         <refentrytitle>tdbtool</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>tdbtool</refname>
  13         <refpurpose>manipulate the contents TDB files</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17
  18         <cmdsynopsis>
  19                 <command>tdbtool</command>
  20         </cmdsynopsis>
  21
  22         <cmdsynopsis>
  23                 <command>tdbtool</command>
  24                 <arg choice="plain">
  25                 <replaceable>TDBFILE</replaceable>
  26                 </arg>
  27                 <arg rep="repeat" choice="opt">
  28                 <replaceable>COMMANDS</replaceable>
  29                 </arg>
  30         </cmdsynopsis>
  31
  32 </refsynopsisdiv>
  33
  34 <refsect1>
  35         <title>DESCRIPTION</title>
  36
  37         <para>This tool is part of the
  38         <citerefentry><refentrytitle>samba</refentrytitle>
  39         <manvolnum>1</manvolnum></citerefentry> suite.</para>
  40
  41         <para><command>tdbtool</command> a tool for displaying and
  42         altering the contents of Samba TDB (Trivial DataBase) files. Each
  43         of the commands listed below can be entered interactively or
  44         provided on the command line.</para>
  45
  46 </refsect1>
  47
  48
  49 <refsect1>
  50         <title>COMMANDS</title>
  51
  52         <variablelist>
  53
  54                 <varlistentry>
  55                 <term><option>create</option>
  56                 <replaceable>TDBFILE</replaceable></term>
  57                 <listitem><para>Create a new database named
  58                 <replaceable>TDBFILE</replaceable>.
  59                 </para></listitem>
  60                 </varlistentry>
  61
  62                 <varlistentry>
  63                 <term><option>open</option>
  64                 <replaceable>TDBFILE</replaceable></term>
  65                 <listitem><para>Open an existing database named
  66                 <replaceable>TDBFILE</replaceable>.
  67                 </para></listitem>
  68                 </varlistentry>
  69
  70                 <varlistentry>
  71                 <term><option>erase</option></term>
  72                 <listitem><para>Erase the current database.
  73                 </para></listitem>
  74                 </varlistentry>
  75
  76                 <varlistentry>
  77                 <term><option>dump</option></term>
  78                 <listitem><para>Dump the current database as strings.
  79                 </para></listitem>
  80                 </varlistentry>
  81
  82                 <varlistentry>
  83                 <term><option>cdump</option></term>
  84                 <listitem><para>Dump the current database as connection records.
  85                 </para></listitem>
  86                 </varlistentry>
  87
  88                 <varlistentry>
  89                 <term><option>keys</option></term>
  90                 <listitem><para>Dump the current database keys as strings.
  91                 </para></listitem>
  92                 </varlistentry>
  93
  94                 <varlistentry>
  95                 <term><option>hexkeys</option></term>
  96                 <listitem><para>Dump the current database keys as hex values.
  97                 </para></listitem>
  98                 </varlistentry>
  99
 100                 <varlistentry>
 101                 <term><option>info</option></term>
 102                 <listitem><para>Print summary information about the
 103                 current database.
 104                 </para></listitem>
 105                 </varlistentry>
 106
 107                 <varlistentry>
 108                 <term><option>insert</option>
 109                 <replaceable>KEY</replaceable>
 110                 <replaceable>DATA</replaceable>
 111                 </term>
 112                 <listitem><para>Insert a record into the
 113                 current database.
 114                 </para></listitem>
 115                 </varlistentry>
 116
 117                 <varlistentry>
 118                 <term><option>move</option>
 119                 <replaceable>KEY</replaceable>
 120                 <replaceable>TDBFILE</replaceable>
 121                 </term>
 122                 <listitem><para>Move a record from the
 123                 current database into <replaceable>TDBFILE</replaceable>.
 124                 </para></listitem>
 125                 </varlistentry>
 126
 127                 <varlistentry>
 128                 <term><option>store</option>
 129                 <replaceable>KEY</replaceable>
 130                 <replaceable>DATA</replaceable>
 131                 </term>
 132                 <listitem><para>Store (replace) a record in the
 133                 current database.
 134                 </para></listitem>
 135                 </varlistentry>
 136
 137                 <varlistentry>
 138                 <term><option>show</option>
 139                 <replaceable>KEY</replaceable>
 140                 </term>
 141                 <listitem><para>Show a record by key.
 142                 </para></listitem>
 143                 </varlistentry>
 144
 145                 <varlistentry>
 146                 <term><option>delete</option>
 147                 <replaceable>KEY</replaceable>
 148                 </term>
 149                 <listitem><para>Delete a record by key.
 150                 </para></listitem>
 151                 </varlistentry>
 152
 153                 <varlistentry>
 154                 <term><option>list</option>
 155                 </term>
 156                 <listitem><para>Print the current database hash table and free list.
 157                 </para></listitem>
 158                 </varlistentry>
 159
 160                 <varlistentry>
 161                 <term><option>free</option>
 162                 </term>
 163                 <listitem><para>Print the current database and free list.
 164                 </para></listitem>
 165                 </varlistentry>
 166
 167                 <varlistentry>
 168                 <term><option>!</option>
 169                 <replaceable>COMMAND</replaceable>
 170                 </term>
 171                 <listitem><para>Execute the given system command.
 172                 </para></listitem>
 173                 </varlistentry>
 174
 175                 <varlistentry>
 176                 <term>
 177                 <option>first</option>
 178                 </term>
 179                 <listitem><para>Print the first record in the current database.
 180                 </para></listitem>
 181                 </varlistentry>
 182
 183                 <varlistentry>
 184                 <term>
 185                 <option>next</option>
 186                 </term>
 187                 <listitem><para>Print the next record in the current database.
 188                 </para></listitem>
 189                 </varlistentry>
 190
 191                 <varlistentry>
 192                 <term>
 193                 <option>quit</option>
 194                 </term>
 195                 <listitem><para>Exit <command>tdbtool</command>.
 196                 </para></listitem>
 197                 </varlistentry>
 198
 199         </variablelist>
 200 </refsect1>
 201
 202 <refsect1>
 203         <title>CAVEATS</title>
 204         <para>The contents of the Samba TDB files are private
 205         to the implementation and should not be altered with
 206         <command>tdbtool</command>.
 207         </para>
 208 </refsect1>
 209
 210 <refsect1>
 211         <title>VERSION</title>
 212         <para>This man page is correct for version 3.0.25 of the Samba suite.</para>
 213 </refsect1>
 214
 215 <refsect1>
 216         <title>AUTHOR</title>
 217
 218         <para> The original Samba software and related utilities were
 219         created by Andrew Tridgell.  Samba is now developed by the
 220         Samba Team as an Open Source project similar to the way the
 221         Linux kernel is developed.</para>
 222 </refsect1>
 223
 224 </refentry>