source: general/genlib/json-c.xml@ 10847bb9

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY json-c-download-http "https://s3.amazonaws.com/json-c_releases/releases/json-c-&json-c-version;.tar.gz">
  <!ENTITY json-c-download-ftp  " ">
  <!ENTITY json-c-md5sum        "bad8f5e91b7b2563ee2d507054c70eb2">
  <!ENTITY json-c-size          "384 KB">
  <!ENTITY json-c-buildsize     "7.9 MB">
  <!ENTITY json-c-time          "0.4 SBU (with tests)">
]>

<sect1 id="json-c" xreflabel="JSON-C-&json-c-version;">
  <?dbhtml filename="json-c.html"?>


  <title>JSON-C-&json-c-version;</title>

  <indexterm zone="json-c">
    <primary sortas="a-JSON-C">JSON-C</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to JSON-C</title>

    <para>
      The <application>JSON-C</application> implements a reference counting
      object model that allows you to easily construct JSON objects in C,
      output them as JSON formatted strings and parse JSON formatted strings
      back into the C representation of JSON objects.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&json-c-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&json-c-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &json-c-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &json-c-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &json-c-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &json-c-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">JSON-C Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>
    </para>

    <bridgehead renderas="sect4">Optional (for documentation)</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> and
      <xref linkend="graphviz"/> (for dot tool)
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of JSON-C</title>
<!--
    <note>
      <para>
        This package does not support parallel build.
      </para>
    </note>
-->
    <para>
      Install <application>JSON-C</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_STATIC_LIBS=OFF     \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      If you have installed <xref linkend="doxygen" role="nodep"/> and
      <xref linkend="graphviz" role="nodep"/>, you can build the documentation
      by running the following command:
    </para>

<screen remap="doc"><userinput>doxygen doc/Doxyfile</userinput></screen>

    <para>
      To test the results, issue: <command>make test</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      If you built the documentation, install it by running the following
      commands as the &root; user:
    </para>

<screen role="root" remap="doc"><userinput>install -d -vm755 /usr/share/doc/json-c-&json-c-version; &amp;&amp;
install -v -m644 doc/html/* /usr/share/doc/json-c-&json-c-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is
      used to apply a higher level of compiler optimizations.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libjson-c.so
        </seg>
        <seg>
          /usr/include/json-c
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libjson-c">
        <term><filename class="libraryfile">libjson-c.so</filename></term>
        <listitem>
          <para>
            contains the <application>JSON-C</application> API functions
          </para>
          <indexterm zone="json-c libjson-c">
            <primary sortas="c-libjson-c">libjson-c.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>