source: archive/gnome/libchamplain.xml@ 48b59802

<?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 libchamplain-download-http
           "&gnome-download-http;/libchamplain/0.12/libchamplain-&libchamplain-version;.tar.xz">
  <!ENTITY libchamplain-download-ftp
           "&gnome-download-ftp;/libchamplain/0.12/libchamplain-&libchamplain-version;.tar.xz">
  <!ENTITY libchamplain-md5sum        "f0d63225c2efa8b367ebf205fa40862a">
  <!ENTITY libchamplain-size          "572 KB">
  <!ENTITY libchamplain-buildsize     "19 MB">
  <!ENTITY libchamplain-time          "0.4 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      The <application>libchamplain</application> is a Clutter based widget
      used to display rich, eye-candy and interactive maps.
    </para>

    &lfs71_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter-gtk"/>,
      <xref linkend="libsoup"/> and
      <xref linkend="sqlite"/>
    </para>

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

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

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/libchamplain"/>
    </para>
  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --enable-vala \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with 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>--enable-vala</option>: This option enables
      building of the Vala bindings. Remove if you don't have
      <xref linkend="vala"/> installed.
    </para>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          libchamplain-0.12.so and libchamplain-gtk-0.12.so
        </seg>
        <seg>
          /usr/include/{libchamplain-0.12,libchamplain-gtk-0.12} and
          /usr/share/gtk-doc/html/{libchamplain,libchamplain-gtk}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libchamplain-0">
        <term><filename class="libraryfile">libchamplain-0.12.so</filename></term>
        <listitem>
          <para>
            contains the <application>libchamplain</application> API functions.
          </para>
          <indexterm zone="libchamplain libchamplain-0">
            <primary sortas="c-libchamplain-">libchamplain-0.12.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libchamplain-gtk-0">
        <term><filename class="libraryfile">libchamplain-gtk-0.12.so</filename></term>
        <listitem>
          <para>
            contains the <application>libchamplain</application> GTK+ bindings.
          </para>
          <indexterm zone="libchamplain libchamplain-gtk-0">
            <primary sortas="c-libchamplain-gtk-0">libchamplain-gtk-0.12.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>