source: general/genlib/qjson.xml@ 12cb8c2d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 qjson-download-http "http://downloads.sourceforge.net/qjson/qjson-&qjson-version;.tar.bz2">
  <!ENTITY qjson-download-ftp  " ">
  <!ENTITY qjson-md5sum        "323fbac54a5a20c0b8fe45c1ced03e2d">
  <!ENTITY qjson-size          "64 KB">
  <!ENTITY qjson-buildsize     "1.4 MB">
  <!ENTITY qjson-time          "less than 0.1 SBU">
]>

<sect1 id="qjson" xreflabel="QJson-&qjson-version;">
  <?dbhtml filename="qjson.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>QJson-&qjson-version;</title>

  <indexterm zone="qjson">
    <primary sortas="a-QJson">QJson</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to QJson</title>

    <para>
      <application>QJson</application> is a Qt-based library that maps JSON
      data to QVariant objects and vice versa.
    </para>

    &lfs76_checked;

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

    <bridgehead renderas="sect3">QJson Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="qt4"/> and
      <xref linkend="cmake"/>
    </para>    
    
    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/qjson"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of QJson</title>

    <para>
      Install <application>QJson</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 \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      This package does not contain a test suite.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>
  
  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><option>-DCMAKE_BUILD_TYPE=Release</option>: This switch is used to
    build without debugging symbols and apply a higher level of compiler 
    optimizations.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          none
        </seg>
        <seg>
          libqjson.so
        </seg>
        <seg>
          /usr/include/json and /usr/lib/cmake/qjson
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libqjson">
        <term><filename class="libraryfile">libqjson.so</filename></term>
        <listitem>
          <para>
            contains <application>QJson</application> API functions.
          </para>
          <indexterm zone="qjson libqjson">
            <primary sortas="c-libqjson">libqjson.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>