docs-xml/manpages/dbwrap_tool.1.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="dbwrap_tool.1">
   4
   5 <refmeta>
   6         <refentrytitle>dbwrap_tool</refentrytitle>
   7         <manvolnum>1</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>dbwrap_tool</refname>
  16         <refpurpose>low level TDB/CTDB manipulation tool using the dbwrap interface</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>dbwrap_tool</command>
  22                 <arg choice="opt">--persistent</arg>
  23                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  24                 <arg choice="opt">-s &lt;config file&gt;</arg>
  25                 <arg choice="opt">-l &lt;log file base&gt;</arg>
  26                 <arg choice="opt">-V</arg>
  27                 <arg choice="opt">--option=&lt;name&gt;=&lt;value&gt;</arg>
  28                 <arg choice="req">&lt;database&gt;</arg>
  29                 <arg choice="req">&lt;operation&gt;</arg>
  30                 <arg choice="opt">&lt;key&gt;
  31                         <arg choice="opt">&lt;type&gt;
  32                                 <arg choice="opt">&lt;value&gt;</arg>
  33                         </arg>
  34                 </arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40
  41         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  42         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  43
  44         <para>The dbwrap_tool program is used to read and manipulate
  45         TDB/CTDB databases using the dbwrap interface.</para>
  46
  47         <para>The following database operations are available:
  48         <itemizedlist>
  49                 <listitem><para>fetch: fetch a record</para></listitem>
  50                 <listitem><para>store: create or modify a record</para></listitem>
  51                 <listitem><para>delete: remove a record</para></listitem>
  52                 <listitem><para>exists: test for existance of a record</para></listitem>
  53                 <listitem><para>erase: remove all records</para></listitem>
  54                 <listitem><para>listkeys: list all available records</para></listitem>
  55                 <listitem><para>listwatchers: list processes, which are waiting for changes in a record</para></listitem>
  56         </itemizedlist>
  57         </para>
  58         <para>The following types are available:
  59         <itemizedlist>
  60                 <listitem><para>int32: signed 32bit integer</para></listitem>
  61                 <listitem><para>uint32: unsigned 32bit integer</para></listitem>
  62                 <listitem><para>string: "hello world"</para></listitem>
  63                 <listitem><para>hex: hex strings like "68656C6C6F20776F726C6400" ("hello world")</para></listitem>
  64         </itemizedlist>
  65         </para>
  66 </refsect1>
  67
  68 <refsect1>
  69         <title>OPTIONS</title>
  70
  71         <variablelist>
  72                 <varlistentry>
  73                         <term>--persistent</term>
  74                         <listitem><para>Open the database as a persistent database.
  75                         If this option is not specified, the database is opened as
  76                         non-persistent.
  77                         </para></listitem>
  78                 </varlistentry>
  79                 &popt.common.samba.client;
  80                 &stdarg.help;
  81         </variablelist>
  82 </refsect1>
  83
  84 <refsect1>
  85         <title>COMMANDS</title>
  86         <refsect2>
  87                 <title>fetch</title>
  88                 <cmdsynopsis>
  89                         <command>dbwrap_tool</command> &lt;database&gt; fetch &lt;key&gt; &lt;type&gt;
  90                 </cmdsynopsis>
  91         </refsect2>
  92         <refsect2>
  93                 <title>store</title>
  94                 <cmdsynopsis>
  95                         <command>dbwrap_tool</command> &lt;database&gt; store &lt;key&gt; &lt;type&gt; &lt;value&gt;
  96                 </cmdsynopsis>
  97         </refsect2>
  98         <refsect2>
  99                 <title>delete</title>
 100                 <cmdsynopsis>
 101                         <command>dbwrap_tool</command> &lt;database&gt; delete &lt;key&gt;
 102                 </cmdsynopsis>
 103         </refsect2>
 104         <refsect2>
 105                 <title>exists</title>
 106                 <cmdsynopsis>
 107                         <command>dbwrap_tool</command> &lt;database&gt; exists &lt;key&gt;
 108                 </cmdsynopsis>
 109         </refsect2>
 110         <refsect2>
 111                 <title>erase</title>
 112                 <cmdsynopsis>
 113                         <command>dbwrap_tool</command> &lt;database&gt; erase </cmdsynopsis>
 114         </refsect2>
 115         <refsect2>
 116                 <title>listkeys</title>
 117                 <cmdsynopsis>
 118                         <command>dbwrap_tool</command> &lt;database&gt; listkeys
 119                 </cmdsynopsis>
 120         </refsect2>
 121         <refsect2>
 122                 <title>listwatchers</title>
 123                 <cmdsynopsis>
 124                         <command>dbwrap_tool</command> &lt;database&gt; listwatchers
 125                 </cmdsynopsis>
 126         </refsect2>
 127 </refsect1>
 128
 129 <refsect1>
 130         <title>EXAMPLES</title>
 131         <variablelist>
 132                 <varlistentry><term>List all keys from winbindd_idmap.tdb</term>
 133                         <listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb listkeys</para></listitem>
 134                 </varlistentry>
 135                 <varlistentry><term>Fetch record with key "USER HWM" as uint32</term>
 136                         <listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb fetch "USER HWM" uint32</para></listitem>
 137                 </varlistentry>
 138                 <varlistentry><term>Remove record with key "USER HWM"</term>
 139                         <listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb remove "USER HWM"</para></listitem>
 140                 </varlistentry>
 141                 <varlistentry><term>Store and overwrite record "USER HWM" with value 214</term>
 142                         <listitem><para>uint32: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" uint32 214</para></listitem>
 143                         <listitem><para>hex: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" hex D6000000</para></listitem>
 144                 </varlistentry>
 145         </variablelist>
 146 </refsect1>
 147
 148 <refsect1>
 149         <title>NOTES</title>
 150
 151         <para>Use with caution!</para>
 152 </refsect1>
 153
 154
 155 <refsect1>
 156         <title>VERSION</title>
 157
 158         <para>This man page is correct for version 3 of the Samba suite.</para>
 159 </refsect1>
 160
 161 <refsect1>
 162         <title>SEE ALSO</title>
 163         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 164         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
 165         <manvolnum>7</manvolnum></citerefentry></para>
 166 </refsect1>
 167
 168 <refsect1>
 169         <title>AUTHOR</title>
 170
 171         <para>The original Samba software and related utilities
 172         were created by Andrew Tridgell. Samba is now developed
 173         by the Samba Team as an Open Source project similar
 174         to the way the Linux kernel is developed.</para>
 175
 176         <para>The dbwrap_tool manpage was written by Bjoern Baumbach.</para>
 177 </refsect1>
 178
 179 </refentry>