source: networking/netlibs/geoclue.xml@ 025d65fc

<?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 geoclue-download-http
  "http://www.freedesktop.org/software/geoclue/releases/2.1/geoclue-&geoclue-version;">
  <!ENTITY geoclue-download-ftp  " ">
  <!ENTITY geoclue-md5sum        "33af8307f332e0065af056ecba65fec2">
  <!ENTITY geoclue-size          "556 KB">
  <!ENTITY geoclue-buildsize     "11 MB">
  <!ENTITY geoclue-time          "0.1 SBU">
]>

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

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

  <title>GeoClue-&geoclue-version;</title>

  <indexterm zone="geoclue">
    <primary sortas="a-geoclue">GeoClue</primary>
  </indexterm>

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

    <para>
      <application>GeoClue</application> is a modular geoinformation service
      built on top of the <application>D-Bus</application> messaging system. The
      goal of the <application>GeoClue</application> project is to make creating
      location-aware applications as simple as possible.
    </para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>, and
      <xref linkend="json-glib"/>
    </para>

    <bridgehead renderas="sect4">Recommended if you are building GNOME</bridgehead>
    <para role="recommended">
      <xref linkend="libsoup"/> and
      <xref linkend="NetworkManager"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://www.freedesktop.org/software/ModemManager/">ModemManager</ulink>, and
      <xref linkend="gtk-doc"/>
    </para>

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

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

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

<screen><userinput>
./configure --prefix=/usr --disable-modem-gps-source --disable-3g-source --sysconfdir=/etc &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>--disable-modem-gps-source</option>: This switch disables
       the modem GPS backend.  Remove it if you have installed the
       optional <application>ModemManager</application> application.
    </para>

    <para>
      <option>--disable-3g-source</option>: This switch disables the
      3G backend.  Remove it if you have installed the optional
      <application>ModemManager</application> application.
    </para>

  </sect2>


  <sect2 role="configuration">
    <title>Configuring Geoclue</title>

    <sect3  id="geoclue-init">
      <title>Systemd Units</title>

      <para>
        To start the <command>geoclue-service</command> at boot, enable
        the previously installed systemd unit by running the following command
        as the <systemitem class="username">root</systemitem> user:
      </para>

      <indexterm zone="geoclue geoclue-init">
        <primary sortas="f-geoclue">geoclue</primary>
      </indexterm>

<screen role="root"><userinput>systemctl enable geoclue</userinput></screen>

    </sect3>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/geoclue /usr/libexec/geoclue-2.0
          and /usr/share/gtk-doc/html/geoclue
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgeoclue">
        <term><filename class="libraryfile">libgeoclue.so</filename></term>
        <listitem>
          <para>
            contains functions that provide the
            <application>GeoClue</application> geoinformation application
            programming interface.
          </para>
          <indexterm zone="geoclue libgeoclue">
            <primary sortas="c-libgeoclue">libgeoclue.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>