From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 26 Jan 2010 12:59:53 +0000 (+0100)
Subject: yaz-json-parse man page
X-Git-Tag: v4.0.1~2
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=4bd71a8e6144a4f1778e10311c407c66ab462c7c;ds=sidebyside

yaz-json-parse man page
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f9db45d..0355eb3 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -15,11 +15,13 @@ HTMLFILES = index.html
 MANFILES=yaz-client.1 yaz-ztest.8 \
 	yaz-config.8 yaz.7 zoomsh.1 yaz-asncomp.1 \
 	yaz-marcdump.1 yaz-iconv.1 yaz-log.7 \
-	yaz-illclient.1 yaz-icu.1 bib1-attr.7
+	yaz-illclient.1 yaz-icu.1 bib1-attr.7 \
+	yaz-json-parse.1
 REFFILES=yaz-client-man.xml yaz-ztest-man.xml yaz-config-man.xml \
 	yaz-man.xml zoomsh-man.xml yaz-asncomp-man.xml \
 	yaz-marcdump-man.xml yaz-iconv-man.xml yaz-log-man.xml \
-	yaz-illclient-man.xml yaz-icu-man.xml bib1-attr-man.xml
+	yaz-illclient-man.xml yaz-icu-man.xml bib1-attr-man.xml \
+	yaz-json-parse-man.xml
 
 SUPPORTFILES=entities.ent apilayer.obj local.ent.in
 
@@ -68,6 +70,9 @@ yaz-log.7: yaz-log-man.xml
 yaz-icu.1: yaz-icu-man.xml
 	$(MAN_COMPILE) $(srcdir)/yaz-icu-man.xml
 
+yaz-json-parse.1: yaz-json-parse-man.xml
+	$(MAN_COMPILE) $(srcdir)/yaz-json-parse-man.xml
+
 $(HTMLFILES): $(XMLFILES)
 	rm -f *.html
 	$(HTML_COMPILE) $(srcdir)/yaz.xml
diff --git a/doc/yaz-json-parse-man.xml b/doc/yaz-json-parse-man.xml
new file mode 100644
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:
+-->