diff options
| author | Björn Baumbach <bb@sernet.de> | 2012-10-15 17:17:29 +0200 |
|---|---|---|
| committer | Michael Adam <obnox@samba.org> | 2013-01-15 14:49:19 +0100 |
| commit | 8d6104f02d9ab879efe7867fec53cbe5cc408ded (patch) | |
| tree | e86541b105f63bb3dd0de096d1fbc64a6152262e /docs-xml | |
| parent | 065c0ec16259f8d57baec5dfe4e6eb9bdea0002a (diff) | |
| download | samba-8d6104f02d9ab879efe7867fec53cbe5cc408ded.tar.gz samba-8d6104f02d9ab879efe7867fec53cbe5cc408ded.tar.bz2 samba-8d6104f02d9ab879efe7867fec53cbe5cc408ded.zip | |
docs-xml: add dbwrap_tool.1 manual page
Signed-off-by: Björn Baumbach <bb@sernet.de>
Reviewed-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
Diffstat (limited to 'docs-xml')
| -rw-r--r-- | docs-xml/manpages/dbwrap_tool.1.xml | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/docs-xml/manpages/dbwrap_tool.1.xml b/docs-xml/manpages/dbwrap_tool.1.xml new file mode 100644 index 0000000000..5a682b8e86 --- /dev/null +++ b/docs-xml/manpages/dbwrap_tool.1.xml @@ -0,0 +1,160 @@ +<?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">4.0</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="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>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> + + <para>None.</para> + <!-- + <variablelist> + </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>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> winbindd_idmap.tdb listkeys</para></listitem> + </varlistentry> + <varlistentry><term>Fetch record with key "USER HWM" as uint32</term> + <listitem><para><command>dbwrap_tool</command> 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> 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> winbindd_idmap.tdb store "USER HWM" uint32 214</para></listitem> + <listitem><para>hex: <command>dbwrap_tool</command> 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 correct for version 3 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> |