[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[69a16457] | 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">
|
---|
[f4ac7141] | 9 | <!ENTITY libgweather-download-ftp " ">
|
---|
[a44cbc50] | 10 | <!ENTITY libgweather-md5sum "42c548a6d45f79c2120b0a0df8a74e68">
|
---|
[2a63215] | 11 | <!ENTITY libgweather-size "2.7 MB">
|
---|
[a44cbc50] | 12 | <!ENTITY libgweather-buildsize "77 MB (with tests)">
|
---|
[05c1d3fc] | 13 | <!ENTITY libgweather-time "0.2 SBU (with tests)">
|
---|
[69a16457] | 14 | ]>
|
---|
| 15 |
|
---|
[51dfb3e] | 16 | <sect1 id="libgweather" xreflabel="libgweather-&libgweather-version;">
|
---|
[69a16457] | 17 | <?dbhtml filename="libgweather.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | <title>libgweather-&libgweather-version;</title>
|
---|
| 21 |
|
---|
| 22 | <indexterm zone="libgweather">
|
---|
| 23 | <primary sortas="a-libgweather">libgweather</primary>
|
---|
| 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
| 27 | <title>Introduction to libgweather</title>
|
---|
| 28 |
|
---|
| 29 | <para>
|
---|
| 30 | The <application>libgweather</application> package is a library used
|
---|
| 31 | to access weather information from online services for numerous
|
---|
| 32 | locations.
|
---|
| 33 | </para>
|
---|
| 34 |
|
---|
[5eaa870e] | 35 | &lfs122_checked;
|
---|
[69a16457] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&libgweather-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&libgweather-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &libgweather-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &libgweather-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &libgweather-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &libgweather-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">libgweather Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
| 75 | <xref linkend="geocode-glib"/>,
|
---|
[71b76886] | 76 | <xref linkend="gtk3"/>,
|
---|
| 77 | <xref linkend="libsoup3"/>, and
|
---|
| 78 | <xref linkend="pygobject3"/>
|
---|
[69a16457] | 79 | </para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 82 | <para role="recommended">
|
---|
[c0bc0a9] | 83 | &gobject-introspection;,
|
---|
[bb8b4003] | 84 | <xref linkend="libxml2"/>, and
|
---|
[69a16457] | 85 | <xref linkend="vala"/>
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
| 88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 89 | <para role="optional">
|
---|
[f56d2e7] | 90 | <xref linkend="gi-docgen"/> (gi-docgen is also provided as a meson
|
---|
[6af00bd] | 91 | subproject, which will be used if <option>-D gtk_doc=false</option>
|
---|
[f56d2e7] | 92 | is not passed to <command>meson</command>),
|
---|
| 93 | <xref linkend="llvm"/> (for clang-format), and
|
---|
| 94 | <ulink url="https://pypi.org/project/pylint/">pylint</ulink>
|
---|
[69a16457] | 95 | </para>
|
---|
| 96 |
|
---|
[55815363] | 97 | &test-use-internet;
|
---|
| 98 |
|
---|
[69a16457] | 99 | </sect2>
|
---|
| 100 |
|
---|
| 101 | <sect2 role="installation">
|
---|
| 102 | <title>Installation of libgweather</title>
|
---|
| 103 |
|
---|
| 104 | <para>
|
---|
| 105 | Install <application>libgweather</application> by running the following
|
---|
| 106 | commands:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[27229db] | 109 | <screen><userinput>mkdir build &&
|
---|
| 110 | cd build &&
|
---|
| 111 |
|
---|
[91318eb] | 112 | meson setup --prefix=/usr \
|
---|
| 113 | --buildtype=release \
|
---|
[6af00bd] | 114 | -D gtk_doc=false \
|
---|
[91318eb] | 115 | .. &&
|
---|
[760d71b] | 116 | ninja</userinput></screen>
|
---|
| 117 |
|
---|
| 118 | <para>
|
---|
| 119 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 120 | the API documentation for this package, issue:
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
| 123 | <screen role='nodump'><userinput>sed "s/libgweather_full_version/'libgweather-&libgweather-version;'/" \
|
---|
| 124 | -i ../doc/meson.build &&
|
---|
[6af00bd] | 125 | meson configure -D gtk_doc=true &&
|
---|
[27229db] | 126 | ninja</userinput></screen>
|
---|
[69a16457] | 127 |
|
---|
| 128 | <para>
|
---|
[71b76886] | 129 | One test needs that the locale files be installed on the system, so
|
---|
[27d3028] | 130 | it is better to run the tests after installing the package.
|
---|
[69a16457] | 131 | </para>
|
---|
| 132 |
|
---|
| 133 | <para>
|
---|
| 134 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 135 | </para>
|
---|
| 136 |
|
---|
[27229db] | 137 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[69a16457] | 138 |
|
---|
[27d3028] | 139 | <para>
|
---|
[05c1d3fc] | 140 | To test the results, issue: <command>LC_ALL=C ninja test</command>.
|
---|
[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>
|
---|
[6af00bd] | 152 | <parameter>-D gtk_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>
|
---|
[2a63215] | 190 | contains functions that allow for 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>
|
---|