source: general/genlib/json-glib.xml

<?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-glib-download-http "&gnome-download-http;/json-glib/1.8/json-glib-&json-glib-version;.tar.xz">
  <!ENTITY json-glib-download-ftp  " ">
  <!ENTITY json-glib-md5sum        "f1aac2b8a17fd68646653cc4d8426486">
  <!ENTITY json-glib-size          "156 KB">
  <!ENTITY json-glib-buildsize     "7.8 MB (with tests)">
  <!ENTITY json-glib-time          "0.2 SBU (with tests)">
]>

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


  <title>JSON-GLib-&json-glib-version;</title>

  <indexterm zone="json-glib">
    <primary sortas="a-JSON-GLib">JSON-GLib</primary>
  </indexterm>

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

    <para>
      The <application>JSON GLib</application> package is a library
      providing serialization and deserialization support for the JavaScript
      Object Notation (JSON) format described by RFC 4627.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/> (GObject Introspection required if building
      GNOME)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of JSON GLib</title>

    <para>
      Install <application>JSON GLib</application> by running the following
      commands:
    </para>

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

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

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

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

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <option>-Dgtk_doc=disabled</option>: Add this option if you have
      <xref role="nodep" linkend="gtk-doc"/> installed and do not wish to
      generate the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          json-glib-format and json-glib-validate
        </seg>
        <seg>
          libjson-glib-1.0.so
        </seg>
        <seg>
          /usr/{include,{libexec,share{/installed-tests}/json-glib-1.0 and
          /usr/share/gtk-doc/html/json-glib
        </seg>
      </seglistitem>
    </segmentedlist>

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

     <varlistentry id="json-glib-format">
        <term><command>json-glib-format</command></term>
        <listitem>
          <para>
            is a simple command line interface to format JSON data
          </para>
          <indexterm zone="json-glib json-glib-format">
            <primary sortas="b-json-glib-format">json-glib-format</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="json-glib-validate">
        <term><command>json-glib-validate</command></term>
        <listitem>
          <para>
            is a simple command line interface to validate JSON data
          </para>
          <indexterm zone="json-glib json-glib-validate">
            <primary sortas="b-json-glib-validate">json-glib-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>