mirror of
https://github.com/samba-team/samba.git
synced 2024-12-22 13:34:15 +03:00
eae6d76a36
writing that they are correct for version x is not always precise. But we're working on that also :-) Signed-off-by: Bjoern Jacke <bjacke@samba.org> Reviewed-by: Andrew Bartlett <abartlet@samba.org> Reviewed-by: Garming Sam <garming@catalyst.net.nz>
194 lines
6.1 KiB
XML
194 lines
6.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
|
|
<refentry id="dbwrap_tool.1">
|
|
|
|
<refmeta>
|
|
<refentrytitle>dbwrap_tool</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo class="source">Samba</refmiscinfo>
|
|
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
|
|
<refmiscinfo class="version">&doc.version;</refmiscinfo>
|
|
</refmeta>
|
|
|
|
|
|
<refnamediv>
|
|
<refname>dbwrap_tool</refname>
|
|
<refpurpose>low level TDB/CTDB manipulation tool using the dbwrap interface</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command>
|
|
<arg choice="opt">--persistent</arg>
|
|
<arg choice="opt">--non-persistent</arg>
|
|
<arg choice="opt">-d <debug level></arg>
|
|
<arg choice="opt">-s <config file></arg>
|
|
<arg choice="opt">-l <log file base></arg>
|
|
<arg choice="opt">-V</arg>
|
|
<arg choice="opt">--option=<name>=<value></arg>
|
|
<arg choice="req"><database></arg>
|
|
<arg choice="req"><operation></arg>
|
|
<arg choice="opt"><key>
|
|
<arg choice="opt"><type>
|
|
<arg choice="opt"><value></arg></arg></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>DESCRIPTION</title>
|
|
|
|
<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
|
|
<manvolnum>7</manvolnum></citerefentry> suite.</para>
|
|
|
|
<para>The dbwrap_tool program is used to read and manipulate
|
|
TDB/CTDB databases using the dbwrap interface.</para>
|
|
|
|
<para>The following database operations are available:
|
|
<itemizedlist>
|
|
<listitem><para>fetch: fetch a record</para></listitem>
|
|
<listitem><para>store: create or modify a record</para></listitem>
|
|
<listitem><para>delete: remove a record</para></listitem>
|
|
<listitem><para>exists: test for existence of a record</para></listitem>
|
|
<listitem><para>erase: remove all records</para></listitem>
|
|
<listitem><para>listkeys: list all available records</para></listitem>
|
|
<listitem><para>listwatchers: list processes, which are waiting for changes in a record</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>The following types are available:
|
|
<itemizedlist>
|
|
<listitem><para>int32: signed 32bit integer</para></listitem>
|
|
<listitem><para>uint32: unsigned 32bit integer</para></listitem>
|
|
<listitem><para>string: "hello world"</para></listitem>
|
|
<listitem><para>hex: hex strings like "68656C6C6F20776F726C6400" ("hello world")</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>OPTIONS</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>--persistent</term>
|
|
<listitem><para>Open the database as a persistent database.
|
|
</para>
|
|
<para>
|
|
Exactly one of --persistent and --non-persistent must be
|
|
specified.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>--non-persistent</term>
|
|
<listitem><para>Open the database as a non-persistent database.
|
|
</para>
|
|
<para>
|
|
Caveat: opening a database as non-persistent when there
|
|
is currently no other opener will wipe the database.
|
|
</para>
|
|
<para>
|
|
Exactly one of --persistent and --non-persistent must be
|
|
specified.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
&popt.common.samba.client;
|
|
&popt.autohelp;
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>COMMANDS</title>
|
|
<refsect2>
|
|
<title>fetch</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> fetch <key> <type>
|
|
</cmdsynopsis>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>store</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> store <key> <type> <value>
|
|
</cmdsynopsis>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>delete</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> delete <key>
|
|
</cmdsynopsis>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>exists</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> exists <key>
|
|
</cmdsynopsis>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>erase</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> erase </cmdsynopsis>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>listkeys</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> listkeys
|
|
</cmdsynopsis>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>listwatchers</title>
|
|
<cmdsynopsis>
|
|
<command>dbwrap_tool</command> <database> listwatchers
|
|
</cmdsynopsis>
|
|
</refsect2>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>EXAMPLES</title>
|
|
<variablelist>
|
|
<varlistentry><term>List all keys from winbindd_idmap.tdb</term>
|
|
<listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb listkeys</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Fetch record with key "USER HWM" as uint32</term>
|
|
<listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb fetch "USER HWM" uint32</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Remove record with key "USER HWM"</term>
|
|
<listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb remove "USER HWM"</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Store and overwrite record "USER HWM" with value 214</term>
|
|
<listitem><para>uint32: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" uint32 214</para></listitem>
|
|
<listitem><para>hex: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" hex D6000000</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>NOTES</title>
|
|
|
|
<para>Use with caution!</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>VERSION</title>
|
|
|
|
<para>This man page is part of version &doc.version; of the Samba suite.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para><citerefentry><refentrytitle>smbd</refentrytitle>
|
|
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
|
|
<manvolnum>7</manvolnum></citerefentry></para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>AUTHOR</title>
|
|
|
|
<para>The original Samba software and related utilities
|
|
were created by Andrew Tridgell. Samba is now developed
|
|
by the Samba Team as an Open Source project similar
|
|
to the way the Linux kernel is developed.</para>
|
|
|
|
<para>The dbwrap_tool manpage was written by Bjoern Baumbach.</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|