doc/yaz-json-parse-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <refentry id="yaz-json-parse">
  12  <refentryinfo>
  13   <productname>YAZ</productname>
  14   <productnumber>&version;</productnumber>
  15  </refentryinfo>
  16
  17  <refmeta>
  18   <refentrytitle>yaz-json-parse</refentrytitle>
  19   <manvolnum>1</manvolnum>
  20  </refmeta>
  21
  22  <refnamediv>
  23   <refname>yaz-json-parse</refname>
  24   <refpurpose>YAZ JSON parser</refpurpose>
  25  </refnamediv>
  26
  27  <refsynopsisdiv>
  28   <cmdsynopsis>
  29    <command>yaz-json-parse</command>
  30    <arg>-p</arg>
  31   </cmdsynopsis>
  32  </refsynopsisdiv>
  33
  34  <refsect1><title>DESCRIPTION</title>
  35   <para>
  36    <command>yaz-json-parse</command> is utility which demonstrates
  37    the JSON API of YAZ. (<filename>yaz/json.h</filename>).
  38   </para>
  39   <para>
  40    The program attempts to parse a JSON from standard input (stdin).
  41    It will return exit code 1 if parsing fails and the parsing error message
  42    will be printed to standard error (stderr). The program returns exit code
  43    0 parsing succeeds and return no output, unless -p is given (see below).
  44   </para>
  45  </refsect1>
  46
  47  <refsect1><title>OPTIONS</title>
  48   <variablelist>
  49    <varlistentry>
  50     <term>-p</term>
  51     <listitem><para>
  52       Makes the JSON parser echo the JSON result string to standard output -
  53       if parsing from stdin was successful.
  54      </para></listitem>
  55    </varlistentry>
  56
  57   </variablelist>
  58  </refsect1>
  59  <refsect1><title>SEE ALSO</title>
  60   <para>
  61    <citerefentry>
  62     <refentrytitle>yaz</refentrytitle>
  63     <manvolnum>7</manvolnum>
  64    </citerefentry>
  65   </para>
  66  </refsect1>
  67 </refentry>
  68
  69 <!-- Keep this comment at the end of the file
  70 Local variables:
  71 mode: sgml
  72 sgml-omittag:t
  73 sgml-shorttag:t
  74 sgml-minimize-attributes:nil
  75 sgml-always-quote-attributes:t
  76 sgml-indent-step:1
  77 sgml-indent-data:t
  78 sgml-parent-document:nil
  79 sgml-local-catalogs: nil
  80 sgml-namecase-general:t
  81 End:
  82 -->