docs: Bump version up to 4.7.
[samba.git] / docs-xml / manpages / dbwrap_tool.1.xml
index f4a638881c09b71c40c2fbbac761e09e2c719731..6d4d21df49b14bbec8e3b780459c77a57ec41fb6 100644 (file)
@@ -7,7 +7,7 @@
        <manvolnum>1</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">System Administration tools</refmiscinfo>
-       <refmiscinfo class="version">4.0</refmiscinfo>
+       <refmiscinfo class="version">4.7</refmiscinfo>
 </refmeta>
 
 
@@ -19,6 +19,8 @@
 <refsynopsisdiv>
        <cmdsynopsis>
                <command>dbwrap_tool</command>
+               <arg choice="opt">--persistent</arg>
+               <arg choice="opt">--non-persistent</arg>
                <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>
@@ -28,9 +30,7 @@
                <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>
+                               <arg choice="opt">&lt;value&gt;</arg></arg></arg>
        </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -48,6 +48,7 @@
                <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>
        <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;
-               &stdarg.help;
+               &popt.autohelp;
        </variablelist>
 </refsect1>
 
                        <command>dbwrap_tool</command> &lt;database&gt; delete &lt;key&gt;
                </cmdsynopsis>
        </refsect2>
+       <refsect2>
+               <title>exists</title>
+               <cmdsynopsis>
+                       <command>dbwrap_tool</command> &lt;database&gt; exists &lt;key&gt;
+               </cmdsynopsis>
+       </refsect2>
        <refsect2>
                <title>erase</title>
                <cmdsynopsis>
        <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>
+                       <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> winbindd_idmap.tdb fetch "USER HWM" uint32</para></listitem>
+                       <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> winbindd_idmap.tdb remove "USER HWM"</para></listitem>
+                       <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> 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>
+                       <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>