docs: document the "--persistent" option in dbwrap_tool(1)
authorMichael Adam <obnox@samba.org>
Mon, 14 Jan 2013 16:22:05 +0000 (17:22 +0100)
committerMichael Adam <obnox@samba.org>
Tue, 15 Jan 2013 13:49:20 +0000 (14:49 +0100)
Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
docs-xml/manpages/dbwrap_tool.1.xml

index f4a638881c09b71c40c2fbbac761e09e2c719731..59ef968b978d4fb3df20fc13073d2af9e8d3c1ab 100644 (file)
@@ -19,6 +19,7 @@
 <refsynopsisdiv>
        <cmdsynopsis>
                <command>dbwrap_tool</command>
+               <arg choice="opt">--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>
        <title>OPTIONS</title>
 
        <variablelist>
+               <varlistentry>
+                       <term>--persistent</term>
+                       <listitem><para>Open the database as a persistent database.
+                       If this option is not specified, the database is opened as
+                       non-persistent.
+                       </para></listitem>
+               </varlistentry>
                &popt.common.samba.client;
                &stdarg.help;
        </variablelist>
        <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>