[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[e6ed4c3] | 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 |
|
---|
[310f0aa] | 7 | <!ENTITY libshumate-download-http "&gnome-download-http;/libshumate/1.3/libshumate-&libshumate-version;.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY libshumate-download-ftp " ">
|
---|
[310f0aa] | 9 | <!ENTITY libshumate-md5sum "aac8813bec6f2aa32112b968ed114360">
|
---|
| 10 | <!ENTITY libshumate-size "5.6 MB">
|
---|
| 11 | <!ENTITY libshumate-buildsize "14.5 MB">
|
---|
[6cb25bc] | 12 | <!ENTITY libshumate-time "0.2 SBU">
|
---|
[e6ed4c3] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libshumate" xreflabel="libshumate-&libshumate-version;">
|
---|
| 16 | <?dbhtml filename="libshumate.html"?>
|
---|
| 17 |
|
---|
| 18 | <title>libshumate-&libshumate-version;</title>
|
---|
| 19 |
|
---|
| 20 | <indexterm zone="libshumate">
|
---|
| 21 | <primary sortas="a-libshumate">libshumate</primary>
|
---|
| 22 | </indexterm>
|
---|
| 23 |
|
---|
| 24 | <sect2 role="package">
|
---|
| 25 | <title>Introduction to libshumate</title>
|
---|
| 26 |
|
---|
| 27 | <para>
|
---|
| 28 | The <application>libshumate</application> package contains a GTK-4 widget
|
---|
| 29 | to display maps.
|
---|
| 30 | </para>
|
---|
| 31 |
|
---|
[5eaa870e] | 32 | &lfs122_checked;
|
---|
[e6ed4c3] | 33 |
|
---|
| 34 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&libshumate-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (FTP): <ulink url="&libshumate-download-ftp;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download MD5 sum: &libshumate-md5sum;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download size: &libshumate-size;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated disk space required: &libshumate-buildsize;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated build time: &libshumate-time;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect3">libshumate Dependencies</bridgehead>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 71 | <para role="required">
|
---|
[dd97b05] | 72 | <xref linkend="gtk4"/>,
|
---|
| 73 | <xref linkend="libsoup3"/>, and
|
---|
| 74 | <xref linkend="protobuf-c"/>
|
---|
[e6ed4c3] | 75 | </para>
|
---|
| 76 |
|
---|
[44723bf9] | 77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 78 | <para role="recommended">
|
---|
[c0bc0a9] | 79 | &gobject-introspection; (required for gnome-maps)
|
---|
[44723bf9] | 80 | </para>
|
---|
| 81 |
|
---|
[e6ed4c3] | 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 83 | <para role="optional">
|
---|
[dd97b05] | 84 | <xref linkend="gi-docgen"/>,
|
---|
| 85 | <xref linkend="valgrind"/>, and
|
---|
[30386446] | 86 | <ulink url="&sysprof-url;">sysprof</ulink>
|
---|
[e6ed4c3] | 87 | </para>
|
---|
| 88 |
|
---|
| 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="installation">
|
---|
| 92 | <title>Installation of libshumate</title>
|
---|
| 93 |
|
---|
| 94 | <para>
|
---|
| 95 | Install <application>libshumate</application> by running the following
|
---|
| 96 | commands:
|
---|
| 97 | </para>
|
---|
| 98 |
|
---|
| 99 | <screen><userinput>mkdir build &&
|
---|
| 100 | cd build &&
|
---|
| 101 |
|
---|
[30386446] | 102 | meson setup --prefix=/usr \
|
---|
| 103 | --buildtype=release \
|
---|
| 104 | --wrap-mode=nodownload \
|
---|
[6af00bd] | 105 | -D gtk_doc=false \
|
---|
| 106 | .. &&
|
---|
[e6ed4c3] | 107 | ninja</userinput></screen>
|
---|
| 108 |
|
---|
[67e2e7f] | 109 | <para>
|
---|
| 110 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 111 | the API documentation for this package, issue:
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
[94cdf0d] | 114 | <screen remap='doc'><userinput>sed -e 's/lib_version/version/' \
|
---|
| 115 | -i ../docs/meson.build &&
|
---|
[6af00bd] | 116 | meson configure -D gtk_doc=true &&
|
---|
[67e2e7f] | 117 | ninja</userinput></screen>
|
---|
| 118 |
|
---|
[e6ed4c3] | 119 | <para>
|
---|
| 120 | To test the results, issue: <command>ninja test</command>.
|
---|
| 121 | </para>
|
---|
[dd97b05] | 122 |
|
---|
[6cb25bc] | 123 | <!--
|
---|
[dd97b05] | 124 | <para>
|
---|
| 125 | The test suite requires this package to be built with special options.
|
---|
| 126 | If you wish to run the tests, follow the instructions after installation.
|
---|
| 127 | </para>
|
---|
[6cb25bc] | 128 | -->
|
---|
[e6ed4c3] | 129 |
|
---|
| 130 | <para>
|
---|
| 131 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[dd97b05] | 135 |
|
---|
[6cb25bc] | 136 | <!--
|
---|
[dd97b05] | 137 | <para>
|
---|
| 138 | If you wish to run the tests, issue:
|
---|
| 139 | </para>
|
---|
| 140 |
|
---|
[6cb25bc] | 141 | <screen><userinput>meson configure - -buildtype=debug &&
|
---|
[dd97b05] | 142 | ninja test</userinput></screen>
|
---|
[6cb25bc] | 143 | -->
|
---|
[dd97b05] | 144 |
|
---|
[e6ed4c3] | 145 | </sect2>
|
---|
| 146 |
|
---|
| 147 | <sect2 role="commands">
|
---|
| 148 | <title>Command Explanations</title>
|
---|
| 149 |
|
---|
| 150 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 151 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
[30386446] | 152 |
|
---|
| 153 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 154 | href="../../xincludes/meson-wrap-nodownload.xml"/>
|
---|
[e6ed4c3] | 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>
|
---|
| 170 | libshumate-1.0.so
|
---|
| 171 | </seg>
|
---|
| 172 | <seg>
|
---|
[67e2e7f] | 173 | /usr/include/shumate-1.0 and
|
---|
| 174 | /usr/share/doc/libshumate-&libshumate-version; (optional)
|
---|
[e6ed4c3] | 175 | </seg>
|
---|
| 176 | </seglistitem>
|
---|
| 177 | </segmentedlist>
|
---|
| 178 |
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="libshumate-1.0">
|
---|
| 185 | <term><filename class="libraryfile">libshumate-1.0.so</filename></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>
|
---|
| 188 | contains functions that provide a GTK-4 widget to display maps
|
---|
| 189 | </para>
|
---|
| 190 | <indexterm zone="libshumate libshumate-1.0">
|
---|
| 191 | <primary sortas="c-libshumate-1.0">libshumate-1.0.so</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 | </variablelist>
|
---|
| 196 | </sect2>
|
---|
| 197 | </sect1>
|
---|