From: Adam Dickmeiss <adam@indexdata.dk>
Date: Fri, 23 Nov 2012 10:03:42 +0000 (+0100)
Subject: Document new settings saveAPDU, APDU
X-Git-Tag: v4.2.47~2
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=a0b43ae242eb940fb511c1d91742e61e442ca191;hp=c91efbe35fe8ff53aeafedf0ffb8f1b90841ecdc

Document new settings saveAPDU, APDU
---

diff --git a/doc/zoom.xml b/doc/zoom.xml
index b12e8f6..63c1c1d 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -306,6 +306,24 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
         protocol packets is emitted on standard error stream.  This
         can be very useful for debugging.
        </entry><entry>0</entry></row>
+      <row><entry>
+        saveAPDU</entry><entry>
+	If set to a true value such as "1", a log of low-level
+        protocol packets is saved. The log can be retrieved by reading
+	option APDU. Setting saveAPDU always has the side effect of
+	resetting the currently saved log. This setting is
+	<emphasis>write-only</emphasis>. If read, NULL will be returned.
+	It is only recognized in
+	<function>ZOOM_connection_option_set</function>.
+       </entry><entry>0</entry></row>
+      <row><entry>
+        APDU</entry><entry>
+	Returns the log of protocol packets. Will be empty if logging
+	is not enabled (see saveAPDU above). This setting is
+	<emphasis>read-only</emphasis>. It is only recognized if used
+	in call to <function>ZOOM_connection_option_get</function> or
+	<function>ZOOM_connection_option_getl</function>.
+       </entry><entry></entry></row>
      </tbody>
     </tgroup>
    </table>