[69a16457] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY libgweather-download-http
|
---|
[27d3028] | 8 | "&gnome-download-http;/libgweather/&libgweather-minor;/libgweather-&libgweather-version;.tar.xz">
|
---|
[69a16457] | 9 | <!ENTITY libgweather-download-ftp
|
---|
[27d3028] | 10 | "&gnome-download-ftp;/libgweather/&libgweather-minor;/libgweather-&libgweather-version;.tar.xz">
|
---|
[71b76886] | 11 | <!ENTITY libgweather-md5sum "4c0c46102dcb5e813ff698e5f713e4bb">
|
---|
| 12 | <!ENTITY libgweather-size "2.6 MB">
|
---|
| 13 | <!ENTITY libgweather-buildsize "95 MB (with tests)">
|
---|
[27d3028] | 14 | <!ENTITY libgweather-time "0.2 SBU (with tests)">
|
---|
[69a16457] | 15 | ]>
|
---|
| 16 |
|
---|
[51dfb3e] | 17 | <sect1 id="libgweather" xreflabel="libgweather-&libgweather-version;">
|
---|
[69a16457] | 18 | <?dbhtml filename="libgweather.html"?>
|
---|
| 19 |
|
---|
| 20 |
|
---|
| 21 | <title>libgweather-&libgweather-version;</title>
|
---|
| 22 |
|
---|
| 23 | <indexterm zone="libgweather">
|
---|
| 24 | <primary sortas="a-libgweather">libgweather</primary>
|
---|
| 25 | </indexterm>
|
---|
| 26 |
|
---|
| 27 | <sect2 role="package">
|
---|
| 28 | <title>Introduction to libgweather</title>
|
---|
| 29 |
|
---|
| 30 | <para>
|
---|
| 31 | The <application>libgweather</application> package is a library used
|
---|
| 32 | to access weather information from online services for numerous
|
---|
| 33 | locations.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[b5c0ca3] | 36 | &lfs120_checked;
|
---|
[69a16457] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&libgweather-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&libgweather-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &libgweather-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &libgweather-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &libgweather-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &libgweather-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">libgweather Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 75 | <para role="required">
|
---|
| 76 | <xref linkend="geocode-glib"/>,
|
---|
[71b76886] | 77 | <xref linkend="gtk3"/>,
|
---|
| 78 | <xref linkend="libsoup3"/>, and
|
---|
| 79 | <xref linkend="pygobject3"/>
|
---|
[69a16457] | 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 83 | <para role="recommended">
|
---|
[bb8b4003] | 84 | <xref linkend="gobject-introspection"/>,
|
---|
| 85 | <xref linkend="libxml2"/>, and
|
---|
[69a16457] | 86 | <xref linkend="vala"/>
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 90 | <para role="optional">
|
---|
[f56d2e7] | 91 | <xref linkend="gi-docgen"/> (gi-docgen is also provided as a meson
|
---|
| 92 | subproject, which will be used if <option>-Dgtk_doc=false</option>
|
---|
| 93 | is not passed to <command>meson</command>),
|
---|
| 94 | <xref linkend="llvm"/> (for clang-format), and
|
---|
| 95 | <ulink url="https://pypi.org/project/pylint/">pylint</ulink>
|
---|
[69a16457] | 96 | </para>
|
---|
| 97 |
|
---|
| 98 | </sect2>
|
---|
| 99 |
|
---|
| 100 | <sect2 role="installation">
|
---|
| 101 | <title>Installation of libgweather</title>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | Install <application>libgweather</application> by running the following
|
---|
| 105 | commands:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
[27229db] | 108 | <screen><userinput>mkdir build &&
|
---|
| 109 | cd build &&
|
---|
| 110 |
|
---|
[91318eb] | 111 | meson setup --prefix=/usr \
|
---|
| 112 | --buildtype=release \
|
---|
| 113 | -Dgtk_doc=false \
|
---|
| 114 | .. &&
|
---|
[760d71b] | 115 | ninja</userinput></screen>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 119 | the API documentation for this package, issue:
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <screen role='nodump'><userinput>sed "s/libgweather_full_version/'libgweather-&libgweather-version;'/" \
|
---|
| 123 | -i ../doc/meson.build &&
|
---|
| 124 | meson configure -Dgtk_doc=true &&
|
---|
[27229db] | 125 | ninja</userinput></screen>
|
---|
[69a16457] | 126 |
|
---|
| 127 | <para>
|
---|
[71b76886] | 128 | One test needs that the locale files be installed on the system, so
|
---|
[27d3028] | 129 | it is better to run the tests after installing the package.
|
---|
[69a16457] | 130 | </para>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
[27229db] | 136 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[69a16457] | 137 |
|
---|
[27d3028] | 138 | <para>
|
---|
[71b76886] | 139 | To test the results, issue: <command>LC_ALL=C ninja test</command>. One
|
---|
| 140 | test, metar, is known to fail.
|
---|
[27d3028] | 141 | </para>
|
---|
| 142 |
|
---|
[69a16457] | 143 | </sect2>
|
---|
| 144 |
|
---|
| 145 | <sect2 role="commands">
|
---|
| 146 | <title>Command Explanations</title>
|
---|
| 147 |
|
---|
[adf17153] | 148 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 149 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 150 |
|
---|
[82192a18] | 151 | <para>
|
---|
[760d71b] | 152 | <parameter>-Dgtk_doc=false</parameter>: &gi-doc-disable;
|
---|
[82192a18] | 153 | </para>
|
---|
[69a16457] | 154 |
|
---|
| 155 | </sect2>
|
---|
| 156 |
|
---|
| 157 | <sect2 role="content">
|
---|
| 158 | <title>Contents</title>
|
---|
| 159 |
|
---|
| 160 | <segmentedlist>
|
---|
| 161 | <segtitle>Installed Programs</segtitle>
|
---|
| 162 | <segtitle>Installed Libraries</segtitle>
|
---|
| 163 | <segtitle>Installed Directories</segtitle>
|
---|
| 164 |
|
---|
| 165 | <seglistitem>
|
---|
| 166 | <seg>
|
---|
| 167 | None
|
---|
| 168 | </seg>
|
---|
| 169 | <seg>
|
---|
[27d3028] | 170 | libgweather-4.so
|
---|
[69a16457] | 171 | </seg>
|
---|
| 172 | <seg>
|
---|
[27d3028] | 173 | /usr/lib/libgweather-4,
|
---|
| 174 | /usr/include/libgweather-4.0,
|
---|
| 175 | /usr/share/gtk-doc/html/libgweather-4.0 (optional), and
|
---|
| 176 | /usr/share/libgweather-4
|
---|
[69a16457] | 177 | </seg>
|
---|
| 178 | </seglistitem>
|
---|
| 179 | </segmentedlist>
|
---|
| 180 |
|
---|
| 181 | <variablelist>
|
---|
| 182 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 183 | <?dbfo list-presentation="list"?>
|
---|
| 184 | <?dbhtml list-presentation="table"?>
|
---|
| 185 |
|
---|
[27d3028] | 186 | <varlistentry id="libgweather-4">
|
---|
| 187 | <term><filename class="libraryfile">libgweather-4.so</filename></term>
|
---|
[69a16457] | 188 | <listitem>
|
---|
| 189 | <para>
|
---|
| 190 | contains functions that allow the retrieval of weather
|
---|
[4c24eb0a] | 191 | information
|
---|
[69a16457] | 192 | </para>
|
---|
[27d3028] | 193 | <indexterm zone="libgweather libgweather-4">
|
---|
[71b76886] | 194 | <primary sortas="c-libgweather-4">libgweather-4.so</primary>
|
---|
[69a16457] | 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
| 199 | </variablelist>
|
---|
| 200 |
|
---|
| 201 | </sect2>
|
---|
| 202 |
|
---|
| 203 | </sect1>
|
---|