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