yaz-json-parse man page

[yaz-moved-to-github.git] / doc / yaz-json-parse-man.xml

diff --git a/doc/yaz-json-parse-man.xml b/doc/yaz-json-parse-man.xml
new file mode 100644 (file)
index 0000000..20af868
--- /dev/null
+++ b/doc/yaz-json-parse-man.xml
@@ -0,0 +1,82 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
+]>
+<refentry id="yaz-json-parse">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
+ 
+ <refmeta>
+  <refentrytitle>yaz-json-parse</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>yaz-json-parse</refname>
+  <refpurpose>YAZ JSON parser</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>yaz-json-parse</command>
+   <arg>-p</arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>yaz-json-parse</command> is utility which demonstrates 
+   the JSON API of YAZ. (<filename>yaz/json.h</filename>).
+  </para>
+  <para>
+   The program attempts to parse a JSON from standard input (stdin).
+   It will return exit code 1 if parsing fails and the parsing error message
+   will be printed to standard error (stderr). The program returns exit code
+   0 parsing succeeds and return no output, unless -p is given (see below).
+  </para>
+ </refsect1>
+
+ <refsect1><title>OPTIONS</title>
+  <variablelist>
+   <varlistentry>
+    <term>-p</term>
+    <listitem><para>
+      Makes the JSON parser echo the JSON result string to standard output -
+      if parsing from stdin was successful.
+     </para></listitem>
+   </varlistentry>
+
+  </variablelist>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>yaz</refentrytitle>
+    <manvolnum>7</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->