glfs/gnome/platform/geocode-glib.xml

<?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 geocode-glib-download-http
           "&gnome-download-http;/geocode-glib/&gnome-minor-26;/geocode-glib-&geocode-glib-version;.tar.xz">
  <!ENTITY geocode-glib-download-ftp
           "&gnome-download-ftp;/geocode-glib/&gnome-minor-26;/geocode-glib-&geocode-glib-version;.tar.xz">
  <!ENTITY geocode-glib-md5sum        "4c0dcdb7ee1222435b20acd3d7b68cd1">
  <!ENTITY geocode-glib-size          "76 KB">
  <!ENTITY geocode-glib-buildsize     "4.6 MB (with tests)">
  <!ENTITY geocode-glib-time          "0.1 SBU (with tests)">
]>

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


  <title>geocode-glib-&geocode-glib-version;</title>

  <indexterm zone="geocode-glib">
    <primary sortas="a-geocode-glib">geocode-glib</primary>
  </indexterm>

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

    <para>
      The <application>Geocode GLib</application> is a convenience library
      for the Yahoo! Place Finder APIs. The Place Finder web service allows
      to do geocoding (finding longitude and latitude from an address), and
      reverse geocoding (finding an address from coordinates).
    </para>

    &lfs113_checked;

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

    <bridgehead renderas="sect3">Geocode GLib Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="json-glib"/> and
      <xref linkend="libsoup3"/>
    </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"/>
    </para>

  </sect2>

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

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

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

meson setup --prefix /usr           \
            --buildtype=release     \
            -Denable-gtk-doc=false  \
            -Dsoup2=false           \
            ..                      &amp;&amp;
ninja</userinput></screen>


    <para>
      To test the results, issue: <command>LANG=C ninja test</command>.
      One test fails because it needs the <literal>sv_SE.utf8</literal> locale,
      which is not installed by default in LFS.
    </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>
      <parameter>-Denable-gtk-doc=false</parameter>: Allow this package to be
      built without <xref linkend="gtk-doc" role="nodep"/>. Remove this
      parameter if <xref linkend="gtk-doc" role="nodep"/> is installed
      and you wish to rebuild and install the API documentation.
    </para>

    <para>
      <parameter>-Dsoup2=false</parameter>: This switch forces this package
      to use libsoup-3 for HTTP requests instead of libsoup-2. The packages in
      BLFS that use geocode-glib now expect libsoup-3 to be used.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgeocode-glib-2.so
        </seg>
        <seg>
          /usr/include/geocode-glib-2.0,
          /usr/libexec/installed-tests/geocode-glib,
          /usr/share/icons/gnome/scalable/places, and
          /usr/share/gtk-doc/html/geocode-glib
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgeocode-glib-2">
        <term><filename class="libraryfile">libgeocode-glib-2.so</filename></term>
        <listitem>
          <para>
            contains the <application>Geocode GLib</application> API functions
          </para>
          <indexterm zone="geocode-glib libgeocode-glib-2">
            <primary sortas="c-libgeocode-glib-2">libgeocode-glib-2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>