source: gnome/platform/libgweather.xml@ 2a63215

<?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/&libgweather-minor;/libgweather-&libgweather-version;.tar.xz">
  <!ENTITY libgweather-download-ftp
           "&gnome-download-ftp;/libgweather/&libgweather-minor;/libgweather-&libgweather-version;.tar.xz">
  <!ENTITY libgweather-md5sum        "bba9065a75a7482be21d0427a12233c0">
  <!ENTITY libgweather-size          "2.7 MB">
  <!ENTITY libgweather-buildsize     "96 MB (with tests)">
  <!ENTITY libgweather-time          "0.3 SBU (with tests)">
]>

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


  <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 used
      to access weather information from online services for numerous
      locations.
    </para>

    &lfs120_checked;

    <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="geocode-glib"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libsoup3"/>, and
      <xref linkend="pygobject3"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/> (gi-docgen is also provided as a meson
      subproject, which will be used if <option>-Dgtk_doc=false</option>
      is not passed to <command>meson</command>),
      <xref linkend="llvm"/> (for clang-format), and
      <ulink url="https://pypi.org/project/pylint/">pylint</ulink>
    </para>

  </sect2>

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

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

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

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

    <para>
      If you have <xref linkend='gi-docgen'/> installed and wish to build
      the API documentation for this package, issue:
    </para>

<screen role='nodump'><userinput>sed "s/libgweather_full_version/'libgweather-&libgweather-version;'/" \
    -i ../doc/meson.build                             &amp;&amp;
meson configure -Dgtk_doc=true                        &amp;&amp;
ninja</userinput></screen>

    <para>
      One test needs that the locale files be installed on the system, so
      it is better to run the tests after installing the package.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

    <para>
      To test the results, issue: <command>LC_ALL=C ninja test</command>. One
      test, <filename>style / style-format</filename>, is known to fail due to
      differences between LLVM-16 and LLVM-17's version of clang-format.
    </para>

  </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>-Dgtk_doc=false</parameter>: &gi-doc-disable;
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgweather-4.so
        </seg>
        <seg>
          /usr/lib/libgweather-4,
          /usr/include/libgweather-4.0,
          /usr/share/gtk-doc/html/libgweather-4.0 (optional), and
          /usr/share/libgweather-4
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgweather-4">
        <term><filename class="libraryfile">libgweather-4.so</filename></term>
        <listitem>
          <para>
            contains functions that allow for the retrieval of weather
            information
          </para>
          <indexterm zone="libgweather libgweather-4">
            <primary sortas="c-libgweather-4">libgweather-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>