Doc: Update list of DLLs/LIBs
[yaz-moved-to-github.git] / doc / yaz-json-parse-man.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2  "http://www.oasis-open.org/docbook/xml/4.4/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   <info><orgname>Index Data</orgname></info>
16  </refentryinfo>
17
18  <refmeta>
19   <refentrytitle>yaz-json-parse</refentrytitle>
20   <manvolnum>1</manvolnum>
21   <refmiscinfo class="manual">Commands</refmiscinfo>
22  </refmeta>
23
24  <refnamediv>
25   <refname>yaz-json-parse</refname>
26   <refpurpose>YAZ JSON parser</refpurpose>
27  </refnamediv>
28
29  <refsynopsisdiv>
30   <cmdsynopsis>
31    <command>yaz-json-parse</command>
32    <arg>-p</arg>
33   </cmdsynopsis>
34  </refsynopsisdiv>
35
36  <refsect1><title>DESCRIPTION</title>
37   <para>
38    <command>yaz-json-parse</command> is utility which demonstrates
39    the JSON API of YAZ. (<filename>yaz/json.h</filename>).
40   </para>
41   <para>
42    The program attempts to parse a JSON from standard input (stdin).
43    It will return exit code 1 if parsing fails and the parsing error message
44    will be printed to standard error (stderr). The program returns exit code
45    0 parsing succeeds and return no output, unless -p is given (see below).
46   </para>
47  </refsect1>
48
49  <refsect1><title>OPTIONS</title>
50   <variablelist>
51    <varlistentry>
52     <term>-p</term>
53     <listitem><para>
54       Makes the JSON parser echo the JSON result string to standard output -
55       if parsing from stdin was successful. If -p is given twice the
56       output is a multi line output with indentation (pretty print).
57      </para></listitem>
58    </varlistentry>
59
60   </variablelist>
61  </refsect1>
62  <refsect1><title>SEE ALSO</title>
63   <para>
64    <citerefentry>
65     <refentrytitle>yaz</refentrytitle>
66     <manvolnum>7</manvolnum>
67    </citerefentry>
68   </para>
69  </refsect1>
70 </refentry>
71
72 <!-- Keep this comment at the end of the file
73 Local variables:
74 mode: sgml
75 sgml-omittag:t
76 sgml-shorttag:t
77 sgml-minimize-attributes:nil
78 sgml-always-quote-attributes:t
79 sgml-indent-step:1
80 sgml-indent-data:t
81 sgml-parent-document:nil
82 sgml-local-catalogs: nil
83 sgml-namecase-general:t
84 End:
85 -->