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