glfs/gnome/core/libgweather.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 libgweather-download-http "&gnome-download-http;/libgweather/&gnome-version;/libgweather-&libgweather-version;.tar.bz2">
  <!ENTITY libgweather-download-ftp "&gnome-download-ftp;/libgweather/&gnome-version;/libgweather-&libgweather-version;.tar.bz2">
  <!ENTITY libgweather-md5sum        "9f4457144d32d4004e0e045240ab51dc">
  <!ENTITY libgweather-size          "6.0 MB">
  <!ENTITY libgweather-buildsize     "224 MB">
  <!ENTITY libgweather-time          "1.7 SBU">
]>

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

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

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

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

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

    <para>The <application>libgweather</application> package is a library to
    access weather information from online services for numerous
    locations.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gtk2"/> and
    <xref linkend="libsoup"/></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;/libgweather"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
             --sysconfdir=&gnome-etc-dir; &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>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-prefix.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-sysconfdir.xml"/>

    <para><option>--disable-glibtest</option>: Use this parameter if you do
    <emphasis role="strong">NOT</emphasis> want to compile and run a test GLIB
    program.</para>

    <para><option>--enable-python</option>: Use this parameter if you want to
    build libgweather python bindings.</para>

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

    <para><option>--enable-gtk-doc-html</option>: Use this parameter if you want
    to build documentation in html format.</para>

    <para><option>--enable-gtk-doc-pdf</option>: Use this parameter if you want
    to build documentation in pdf format.</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>libgweather.{so,a}</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/libgweather,
        share/{gtk-doc/html/libgweather,libgweather}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgweather-lib">
        <term><filename class='libraryfile'>libgweather.{so,a}</filename></term>
        <listitem>
          <para>contains functions that allow the retrieval of weather
          information.</para>
          <indexterm zone="libgweather libgweather-lib">
            <primary sortas="c-libgweather">libgweather.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>