From 1bb8faa31c28bb495e9f60e42a104ab9bb64c951 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Baumbach?= <bb@sernet.de>
Date: Mon, 15 Oct 2012 17:17:29 +0200
Subject: [PATCH 1/7] docs-xml: add dbwrap_tool.1 manual page (fix bug #9568
 [1/2])
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Björn Baumbach <bb@sernet.de>
Reviewed-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit 8d6104f02d9ab879efe7867fec53cbe5cc408ded)
---
 docs-xml/manpages/dbwrap_tool.1.xml | 160 ++++++++++++++++++++++++++++++++++++
 1 file changed, 160 insertions(+)
 create mode 100644 docs-xml/manpages/dbwrap_tool.1.xml

diff --git a/docs-xml/manpages/dbwrap_tool.1.xml b/docs-xml/manpages/dbwrap_tool.1.xml
new file mode 100644
index 0000000..5a682b8
--- /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">&lt;database&gt;</arg>
+		<arg choice="req">&lt;operation&gt;</arg>
+		<arg choice="opt">&lt;key&gt;
+			<arg choice="opt">&lt;type&gt;
+				<arg choice="opt">&lt;value&gt;</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> &lt;database&gt; fetch &lt;key&gt; &lt;type&gt;
+		</cmdsynopsis>
+	</refsect2>
+	<refsect2>
+		<title>store</title>
+		<cmdsynopsis>
+			<command>dbwrap_tool</command> &lt;database&gt; store &lt;key&gt; &lt;type&gt; &lt;value&gt;
+		</cmdsynopsis>
+	</refsect2>
+	<refsect2>
+		<title>delete</title>
+		<cmdsynopsis>
+			<command>dbwrap_tool</command> &lt;database&gt; delete &lt;key&gt;
+		</cmdsynopsis>
+	</refsect2>
+	<refsect2>
+		<title>erase</title>
+		<cmdsynopsis>
+			<command>dbwrap_tool</command> &lt;database&gt; erase </cmdsynopsis>
+	</refsect2>
+	<refsect2>
+		<title>listkeys</title>
+		<cmdsynopsis>
+			<command>dbwrap_tool</command> &lt;database&gt; listkeys
+		</cmdsynopsis>
+	</refsect2>
+	<refsect2>
+		<title>listwatchers</title>
+		<cmdsynopsis>
+			<command>dbwrap_tool</command> &lt;database&gt; 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>
-- 
1.7.12.4


From 254d2aa6ad242611eeef90223d6f93769778049f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Baumbach?= <bb@sernet.de>
Date: Mon, 15 Oct 2012 17:20:07 +0200
Subject: [PATCH 2/7] build(waf): docs-xml: build new dbwrap_tool.8 manual
 page (fix bug #9568 [2/2])
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Björn Baumbach <bb@sernet.de>
Reviewed-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit b7a091ecf48963e2a0d1757d0faf131ad8d940fa)
---
 docs-xml/wscript_build | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build
index 8a5f3a4..25e381e 100644
--- a/docs-xml/wscript_build
+++ b/docs-xml/wscript_build
@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 from samba_utils import save_file
 manpages='''
+         manpages/dbwrap_tool.1
          manpages/eventlogadm.8
          manpages/findsmb.1
          manpages/libsmbclient.7
-- 
1.7.12.4


From 044181dc218b29a83d1b4448503126ee077e0d5f Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox@samba.org>
Date: Mon, 14 Jan 2013 17:05:05 +0100
Subject: [PATCH 3/7] docs: add an entity stdarg.option for the "--option"
 command line parameter

Related to bug #9568.

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit c9b95eb205abbdb77960eb0419937512358f7e64)
---
 docs-xml/build/DTD/samba.entities | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities
index c7e46c2..628dfa7 100644
--- a/docs-xml/build/DTD/samba.entities
+++ b/docs-xml/build/DTD/samba.entities
@@ -241,6 +241,18 @@ log.smbd, etc...). The log file is never removed by the client.
 </para></listitem>
 </varlistentry>'>
 
+<!ENTITY stdarg.option '
+<varlistentry>
+<term>--option=&lt;name&gt;=&lt;value&gt;</term>
+<listitem><para>Set the
+<citerefentry><refentrytitle>smb.conf</refentrytitle>
+<manvolnum>5</manvolnum></citerefentry>
+option "&lt;name&gt;" to value "&lt;value&gt;" from the command line.
+This overrides compiled-in defaults and options read from the configuration
+file.
+</para></listitem>
+</varlistentry>'>
+
 <!ENTITY popt.common.samba '
 &stdarg.version;
 &stdarg.configfile;
-- 
1.7.12.4


From 08936dae0db485b7c7967d8591445f8a28d9ed41 Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox@samba.org>
Date: Mon, 14 Jan 2013 17:06:03 +0100
Subject: [PATCH 4/7] docs: use the stdarg.option entity in the
 popt.common.samba entity

Related to bug #9568.

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit e3db3db784085bb2fedbf3063154b7cd77630e59)
---
 docs-xml/build/DTD/samba.entities | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities
index 628dfa7..2653f41 100644
--- a/docs-xml/build/DTD/samba.entities
+++ b/docs-xml/build/DTD/samba.entities
@@ -257,6 +257,7 @@ file.
 &stdarg.version;
 &stdarg.configfile;
 &stdarg.log-basename;
+&stdarg.option;
 '>
 
 <!ENTITY stdarg.resolve.order '
-- 
1.7.12.4


From f8c32e2e19c31bed32e480ce6e3efdce1e5232cf Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox@samba.org>
Date: Mon, 14 Jan 2013 17:12:51 +0100
Subject: [PATCH 5/7] docs: fix the stdarg.configfile entity to print a "="
 sign after the long option

This makes the appearance equal to the other options like --debuglevel or
--log-basename.

Related to bug #9568.

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit 2ab3a96d262f60d26a8cd16dded3296889ab7f3f)
---
 docs-xml/build/DTD/samba.entities | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities
index 2653f41..32bd097 100644
--- a/docs-xml/build/DTD/samba.entities
+++ b/docs-xml/build/DTD/samba.entities
@@ -214,7 +214,7 @@ in the &smb.conf; file.</para>
 
 <!ENTITY stdarg.configfile '
 <varlistentry>
-<term>-s|--configfile &lt;configuration file&gt;</term>
+<term>-s|--configfile=&lt;configuration file&gt;</term>
 <listitem><para>The file specified contains the 
 configuration details required by the server.  The 
 information in this file includes server-specific
-- 
1.7.12.4


From fbeec0d5fdf17f4f689a1f3194cff2d901b94aea Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox@samba.org>
Date: Mon, 14 Jan 2013 17:08:30 +0100
Subject: [PATCH 6/7] docs: add popt.common.samba.server and
 popt.common.samba.client entities

These are comprised by the popt.common.samba entity and the stdarg.server.debug
or the stdarg.client.debut entity, respectively.
The difference is only in the default value of the debug level setting.

Related to bug #9568.

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit 2d30e5deaf731839402b47751683d2c0e32d2bc7)
---
 docs-xml/build/DTD/samba.entities | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs-xml/build/DTD/samba.entities b/docs-xml/build/DTD/samba.entities
index 32bd097..c9c6744 100644
--- a/docs-xml/build/DTD/samba.entities
+++ b/docs-xml/build/DTD/samba.entities
@@ -260,6 +260,17 @@ file.
 &stdarg.option;
 '>
 
+<!ENTITY popt.common.samba.client '
+&stdarg.client.debug;
+&popt.common.samba;
+'>
+
+<!ENTITY popt.common.samba.server '
+&stdarg.server.debug;
+&popt.common.samba;
+'>
+
+
 <!ENTITY stdarg.resolve.order '
 <varlistentry>
 <term>-R|--name-resolve &lt;name resolve order&gt;</term>
-- 
1.7.12.4


From 97f82d5fd7947ce1a3b675c88ec49869923d373d Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox@samba.org>
Date: Mon, 14 Jan 2013 17:15:08 +0100
Subject: [PATCH 7/7] docs: document the command line options in
 dbwrap_tool(1)

Related to bug #9568.

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
(cherry picked from commit d67911bafc0d098e67c8ad8d9b4bc49f184ff832)
---
 docs-xml/manpages/dbwrap_tool.1.xml | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/docs-xml/manpages/dbwrap_tool.1.xml b/docs-xml/manpages/dbwrap_tool.1.xml
index 5a682b8..f4a6388 100644
--- a/docs-xml/manpages/dbwrap_tool.1.xml
+++ b/docs-xml/manpages/dbwrap_tool.1.xml
@@ -19,6 +19,11 @@
 <refsynopsisdiv>
 	<cmdsynopsis>
 		<command>dbwrap_tool</command>
+		<arg choice="opt">-d &lt;debug level&gt;</arg>
+		<arg choice="opt">-s &lt;config file&gt;</arg>
+		<arg choice="opt">-l &lt;log file base&gt;</arg>
+		<arg choice="opt">-V</arg>
+		<arg choice="opt">--option=&lt;name&gt;=&lt;value&gt;</arg>
 		<arg choice="req">&lt;database&gt;</arg>
 		<arg choice="req">&lt;operation&gt;</arg>
 		<arg choice="opt">&lt;key&gt;
@@ -61,11 +66,10 @@
 <refsect1>
 	<title>OPTIONS</title>
 
-	<para>None.</para>
-	<!--
 	<variablelist>
+		&popt.common.samba.client;
+		&stdarg.help;
 	</variablelist>
-	-->
 </refsect1>
 
 <refsect1>
-- 
1.7.12.4