source: general/genlib/libxmlb.xml@ 073a9623

<?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 libxmlb-download-http "https://github.com/hughsie/libxmlb/releases/download/&libxmlb-version;/libxmlb-&libxmlb-version;.tar.xz">
  <!ENTITY libxmlb-download-ftp  " ">
  <!ENTITY libxmlb-md5sum        "c2e2af788950f3c73e078f89d56ef6ed">
  <!ENTITY libxmlb-size          "100 KB">
  <!ENTITY libxmlb-buildsize     "7.3 MB">
  <!ENTITY libxmlb-time          "0.2 SBU">
]>

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

  <title>libxmlb-&libxmlb-version;</title>

  <indexterm zone="libxmlb">
    <primary sortas="a-libxmlb">libxmlb</primary>
  </indexterm>

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

    <para>
      The <application>libxmlb</application> package contains a library and
      a tool which help create and query binary XML blobs.
    </para>

    &lfs120_checked;

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

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
    </para>

    <!--  Only use this if you want to note something in the wiki
    <para condition="html" role="usernotes">
      Editor Notes: <ulink url="&blfs-wiki;/libxmlb"/>
    </para>
    -->
  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release -Dgtkdoc=false .. &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"/>
    
<!-- Over in meson_options.txt, gtkdoc is set to 'true' by default. This would
     introduce a dependency on gtk-doc, so let's set it as 'false' and let the
     user enable it if they want the documentation. -renodr -->
    <para>
      <parameter>-Dgtkdoc=false</parameter>: This switch disables building the
      API documentation. Remove it if you have
      <xref linkend="gtk-doc" role="nodep"/> installed and wish to build the
      API documentation.
    </para>

    <para>
      <option>-Dintrospection=false</option>: Use this switch if you do not
      have <xref linkend="gobject-introspection" role="nodep"/> installed.
    </para>

    <para>
      <option>-Dstemmer=true</option>: Use this switch if you have
      <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
      installed and wish to build stemmer support.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          xb-tool
        </seg>
        <seg>
          libxmlb.so
        </seg>
        <seg>
          /usr/include/libxmlb-2,
          /usr/libexec/installed-tests/libxmlb, and
          /usr/share/gtk-doc/html/libxmlb (if gtk-doc was enabled)
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xb-tool">
        <term><command>xb-tool</command></term>
        <listitem>
          <para>
            is a tool used to create, dump, or query a binary XML blob
          </para>
          <indexterm zone="libxmlb xb-tool">
            <primary sortas="b-xb-tool">xb-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxmlb-lib">
        <term><filename class="libraryfile">libxmlb.so</filename></term>
        <listitem>
          <para>
            contains functions that allow for creating and querying binary XML
            blobs
          </para>
          <indexterm zone="libxmlb libxmlb-lib">
            <primary sortas="c-libxmlb">libxmlb.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>