1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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
|
---|
8 | "&gnome-download-http;/libgweather/&libgweather-minor;/libgweather-&libgweather-version;.tar.xz">
|
---|
9 | <!ENTITY libgweather-download-ftp " ">
|
---|
10 | <!ENTITY libgweather-md5sum "bba9065a75a7482be21d0427a12233c0">
|
---|
11 | <!ENTITY libgweather-size "2.7 MB">
|
---|
12 | <!ENTITY libgweather-buildsize "96 MB (with tests)">
|
---|
13 | <!ENTITY libgweather-time "0.3 SBU (with tests)">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="libgweather" xreflabel="libgweather-&libgweather-version;">
|
---|
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 |
|
---|
35 | &lfs120_checked;
|
---|
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"/>,
|
---|
76 | <xref linkend="gtk3"/>,
|
---|
77 | <xref linkend="libsoup3"/>, and
|
---|
78 | <xref linkend="pygobject3"/>
|
---|
79 | </para>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
82 | <para role="recommended">
|
---|
83 | <xref linkend="gobject-introspection"/>,
|
---|
84 | <xref linkend="libxml2"/>, and
|
---|
85 | <xref linkend="vala"/>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
89 | <para role="optional">
|
---|
90 | <xref linkend="gi-docgen"/> (gi-docgen is also provided as a meson
|
---|
91 | subproject, which will be used if <option>-Dgtk_doc=false</option>
|
---|
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>
|
---|
95 | </para>
|
---|
96 |
|
---|
97 | &test-use-internet;
|
---|
98 |
|
---|
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 |
|
---|
109 | <screen><userinput>mkdir build &&
|
---|
110 | cd build &&
|
---|
111 |
|
---|
112 | meson setup --prefix=/usr \
|
---|
113 | --buildtype=release \
|
---|
114 | -Dgtk_doc=false \
|
---|
115 | .. &&
|
---|
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 &&
|
---|
125 | meson configure -Dgtk_doc=true &&
|
---|
126 | ninja</userinput></screen>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | One test needs that the locale files be installed on the system, so
|
---|
130 | it is better to run the tests after installing the package.
|
---|
131 | </para>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
138 |
|
---|
139 | <para>
|
---|
140 | To test the results, issue: <command>LC_ALL=C ninja test</command>. One
|
---|
141 | test, <filename>style / style-format</filename>, is known to fail due to
|
---|
142 | differences between LLVM-16 and LLVM-17's version of clang-format.
|
---|
143 | <!--
|
---|
144 | https://gitlab.gnome.org/GNOME/libgweather/-/commit/3c60094ffdc5
|
---|
145 | It's not a simple URL change, so just document it instead of
|
---|
146 | patching the test suite...
|
---|
147 | -->
|
---|
148 | One test named <filename>libgweather / metar</filename> is known to
|
---|
149 | fail because it requires some online resources which have been moved
|
---|
150 | away.
|
---|
151 | </para>
|
---|
152 |
|
---|
153 | </sect2>
|
---|
154 |
|
---|
155 | <sect2 role="commands">
|
---|
156 | <title>Command Explanations</title>
|
---|
157 |
|
---|
158 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
159 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
160 |
|
---|
161 | <para>
|
---|
162 | <parameter>-Dgtk_doc=false</parameter>: &gi-doc-disable;
|
---|
163 | </para>
|
---|
164 |
|
---|
165 | </sect2>
|
---|
166 |
|
---|
167 | <sect2 role="content">
|
---|
168 | <title>Contents</title>
|
---|
169 |
|
---|
170 | <segmentedlist>
|
---|
171 | <segtitle>Installed Programs</segtitle>
|
---|
172 | <segtitle>Installed Libraries</segtitle>
|
---|
173 | <segtitle>Installed Directories</segtitle>
|
---|
174 |
|
---|
175 | <seglistitem>
|
---|
176 | <seg>
|
---|
177 | None
|
---|
178 | </seg>
|
---|
179 | <seg>
|
---|
180 | libgweather-4.so
|
---|
181 | </seg>
|
---|
182 | <seg>
|
---|
183 | /usr/lib/libgweather-4,
|
---|
184 | /usr/include/libgweather-4.0,
|
---|
185 | /usr/share/gtk-doc/html/libgweather-4.0 (optional), and
|
---|
186 | /usr/share/libgweather-4
|
---|
187 | </seg>
|
---|
188 | </seglistitem>
|
---|
189 | </segmentedlist>
|
---|
190 |
|
---|
191 | <variablelist>
|
---|
192 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
193 | <?dbfo list-presentation="list"?>
|
---|
194 | <?dbhtml list-presentation="table"?>
|
---|
195 |
|
---|
196 | <varlistentry id="libgweather-4">
|
---|
197 | <term><filename class="libraryfile">libgweather-4.so</filename></term>
|
---|
198 | <listitem>
|
---|
199 | <para>
|
---|
200 | contains functions that allow for the retrieval of weather
|
---|
201 | information
|
---|
202 | </para>
|
---|
203 | <indexterm zone="libgweather libgweather-4">
|
---|
204 | <primary sortas="c-libgweather-4">libgweather-4.so</primary>
|
---|
205 | </indexterm>
|
---|
206 | </listitem>
|
---|
207 | </varlistentry>
|
---|
208 |
|
---|
209 | </variablelist>
|
---|
210 |
|
---|
211 | </sect2>
|
---|
212 |
|
---|
213 | </sect1>
|
---|