| 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 libsoup-download-http
|
|---|
| 8 | "&gnome-download-http;/libsoup/&libsoup-minor;/libsoup-&libsoup-version;.tar.xz">
|
|---|
| 9 | <!ENTITY libsoup-download-ftp
|
|---|
| 10 | "&gnome-download-ftp;/libsoup/&libsoup-minor;/libsoup-&libsoup-version;.tar.xz">
|
|---|
| 11 | <!ENTITY libsoup-md5sum "8f657fd301a213629204b3320c35d75a">
|
|---|
| 12 | <!ENTITY libsoup-size "1.4 MB">
|
|---|
| 13 | <!ENTITY libsoup-buildsize "17 MB (with tests)">
|
|---|
| 14 | <!ENTITY libsoup-time "0.3 SBU (Using parallelism=4; with tests)">
|
|---|
| 15 | ]>
|
|---|
| 16 |
|
|---|
| 17 | <sect1 id="libsoup" xreflabel="libsoup-&libsoup-version;">
|
|---|
| 18 | <?dbhtml filename="libsoup.html"?>
|
|---|
| 19 |
|
|---|
| 20 |
|
|---|
| 21 | <title>libsoup-&libsoup-version;</title>
|
|---|
| 22 |
|
|---|
| 23 | <indexterm zone="libsoup">
|
|---|
| 24 | <primary sortas="a-libsoup">libsoup</primary>
|
|---|
| 25 | </indexterm>
|
|---|
| 26 |
|
|---|
| 27 | <sect2 role="package">
|
|---|
| 28 | <title>Introduction to libsoup</title>
|
|---|
| 29 |
|
|---|
| 30 | <para>
|
|---|
| 31 | The <application>libsoup</application> is a HTTP client/server library for
|
|---|
| 32 | <application>GNOME</application>. It uses GObject and the GLib main loop
|
|---|
| 33 | to integrate with <application>GNOME</application> applications and
|
|---|
| 34 | it also has an asynchronous API for use in threaded applications.
|
|---|
| 35 | </para>
|
|---|
| 36 |
|
|---|
| 37 | &lfs120_checked;
|
|---|
| 38 |
|
|---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 40 | <itemizedlist spacing="compact">
|
|---|
| 41 | <listitem>
|
|---|
| 42 | <para>
|
|---|
| 43 | Download (HTTP): <ulink url="&libsoup-download-http;"/>
|
|---|
| 44 | </para>
|
|---|
| 45 | </listitem>
|
|---|
| 46 | <listitem>
|
|---|
| 47 | <para>
|
|---|
| 48 | Download (FTP): <ulink url="&libsoup-download-ftp;"/>
|
|---|
| 49 | </para>
|
|---|
| 50 | </listitem>
|
|---|
| 51 | <listitem>
|
|---|
| 52 | <para>
|
|---|
| 53 | Download MD5 sum: &libsoup-md5sum;
|
|---|
| 54 | </para>
|
|---|
| 55 | </listitem>
|
|---|
| 56 | <listitem>
|
|---|
| 57 | <para>
|
|---|
| 58 | Download size: &libsoup-size;
|
|---|
| 59 | </para>
|
|---|
| 60 | </listitem>
|
|---|
| 61 | <listitem>
|
|---|
| 62 | <para>
|
|---|
| 63 | Estimated disk space required: &libsoup-buildsize;
|
|---|
| 64 | </para>
|
|---|
| 65 | </listitem>
|
|---|
| 66 | <listitem>
|
|---|
| 67 | <para>
|
|---|
| 68 | Estimated build time: &libsoup-time;
|
|---|
| 69 | </para>
|
|---|
| 70 | </listitem>
|
|---|
| 71 | </itemizedlist>
|
|---|
| 72 | <!--
|
|---|
| 73 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|---|
| 74 | <itemizedlist spacing="compact">
|
|---|
| 75 | <listitem>
|
|---|
| 76 | <para>
|
|---|
| 77 | Required patch:
|
|---|
| 78 | <ulink url="&patch-root;/libsoup-&libsoup-version;-testsuite_fix-1.patch"/>
|
|---|
| 79 | </para>
|
|---|
| 80 | </listitem>
|
|---|
| 81 | </itemizedlist>
|
|---|
| 82 | -->
|
|---|
| 83 | <!--
|
|---|
| 84 | <warning>
|
|---|
| 85 | <para>
|
|---|
| 86 | You may have noticed newer libsoup releases versioned 3.x.y is
|
|---|
| 87 | available. However, currently some downstream packages support
|
|---|
| 88 | libsoup-3.x, while the others do not. Installing libsoup-3.x into
|
|---|
| 89 | BLFS is known to cause troubles, even if both libsoup-2.x and 3.x
|
|---|
| 90 | are installed. So, do <emphasis role='bold'>not</emphasis> install
|
|---|
| 91 | libsoup-3.x into BLFS unless you know what you are doing. We plan
|
|---|
| 92 | to keep using libsoup-2.x for BLFS until GNOME-43 release.
|
|---|
| 93 | </para>
|
|---|
| 94 | </warning>
|
|---|
| 95 | -->
|
|---|
| 96 | <bridgehead renderas="sect3">libsoup Dependencies</bridgehead>
|
|---|
| 97 |
|
|---|
| 98 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 99 | <para role="required">
|
|---|
| 100 | <xref linkend="glib-networking"/>,
|
|---|
| 101 | <xref linkend="libpsl"/>,
|
|---|
| 102 | <xref linkend="libxml2"/>, and
|
|---|
| 103 | <xref linkend="sqlite"/>
|
|---|
| 104 | </para>
|
|---|
| 105 |
|
|---|
| 106 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 107 | <para role="recommended">
|
|---|
| 108 | <xref linkend="gobject-introspection"/> and
|
|---|
| 109 | <xref linkend="vala"/>
|
|---|
| 110 | </para>
|
|---|
| 111 |
|
|---|
| 112 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 113 | <para role="optional">
|
|---|
| 114 | <xref linkend="apache"/> (required to run the test suite),
|
|---|
| 115 | <xref linkend="brotli"/>,
|
|---|
| 116 | <xref linkend="curl"/> (required to run the test suite),
|
|---|
| 117 | <xref linkend="sysprof"/> (for profiling),
|
|---|
| 118 | <xref linkend="mitkrb"/> (required to run the test suite),
|
|---|
| 119 | <xref linkend="gtk-doc"/>,
|
|---|
| 120 | <!-- It seems that XMLRPC is part of PHP 5.4.10 -->
|
|---|
| 121 | <xref linkend="php"/> compiled with XMLRPC-EPI
|
|---|
| 122 | support (only used for the XMLRPC regression tests), and
|
|---|
| 123 | <xref linkend="samba"/> (ntlm_auth is required to run the test suite)
|
|---|
| 124 | </para>
|
|---|
| 125 |
|
|---|
| 126 | </sect2>
|
|---|
| 127 |
|
|---|
| 128 | <sect2 role="installation">
|
|---|
| 129 | <title>Installation of libsoup</title>
|
|---|
| 130 | <!--
|
|---|
| 131 | <para>
|
|---|
| 132 | First, fix a problem in the test suite caused by
|
|---|
| 133 | <xref role="nodep" linkend="glib-networking"/>:
|
|---|
| 134 | </para>
|
|---|
| 135 |
|
|---|
| 136 | <screen><userinput remap="pre">patch -Np1 -i ../libsoup-&libsoup-version;-testsuite_fix-1.patch</userinput></screen>
|
|---|
| 137 | -->
|
|---|
| 138 | <para>
|
|---|
| 139 | Install <application>libsoup</application> by running the following
|
|---|
| 140 | commands:
|
|---|
| 141 | </para>
|
|---|
| 142 |
|
|---|
| 143 | <screen><userinput>mkdir build &&
|
|---|
| 144 | cd build &&
|
|---|
| 145 |
|
|---|
| 146 | meson setup --prefix=/usr \
|
|---|
| 147 | --buildtype=release \
|
|---|
| 148 | -Dvapi=enabled \
|
|---|
| 149 | -Dgssapi=disabled \
|
|---|
| 150 | -Dsysprof=disabled \
|
|---|
| 151 | .. &&
|
|---|
| 152 | ninja</userinput></screen>
|
|---|
| 153 |
|
|---|
| 154 | <para>
|
|---|
| 155 | To test the results, issue: <command>ninja test</command>.
|
|---|
| 156 | <!-- Upstream issue #120. -->
|
|---|
| 157 | One test named <filename>ssl-test</filename> is known to fail.
|
|---|
| 158 | </para>
|
|---|
| 159 |
|
|---|
| 160 | <para>
|
|---|
| 161 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 162 | </para>
|
|---|
| 163 |
|
|---|
| 164 | <screen role="root"><userinput>ninja install</userinput></screen>
|
|---|
| 165 |
|
|---|
| 166 | </sect2>
|
|---|
| 167 |
|
|---|
| 168 | <sect2 role="commands">
|
|---|
| 169 | <title>Command Explanations</title>
|
|---|
| 170 |
|
|---|
| 171 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 172 | href="../../xincludes/meson-buildtype-release.xml"/>
|
|---|
| 173 |
|
|---|
| 174 | <para>
|
|---|
| 175 | <option>-Dvapi=disabled</option>: Use this if you have not installed
|
|---|
| 176 | <application>Vala</application>, e.g. because you are not building
|
|---|
| 177 | <application>GNOME</application>.
|
|---|
| 178 | </para>
|
|---|
| 179 |
|
|---|
| 180 | <para>
|
|---|
| 181 | <option>-Ddoc=enabled</option>: Use this option if you want to build
|
|---|
| 182 | the documentation. Note that you must have <xref linkend="gtk-doc"/> installed.
|
|---|
| 183 | </para>
|
|---|
| 184 |
|
|---|
| 185 | <para>
|
|---|
| 186 | <parameter>-Dgssapi=disabled</parameter>: libsoup defaults to building with GSSAPI support,
|
|---|
| 187 | which requires Kerberos (as does the test suite). If you are building GNOME or
|
|---|
| 188 | have kerberos installed, remove this option.
|
|---|
| 189 | </para>
|
|---|
| 190 |
|
|---|
| 191 | <para>
|
|---|
| 192 | <parameter>-Dsysprof=disabled</parameter>: libsoup will automatically download
|
|---|
| 193 | a git version of <xref linkend="sysprof"/> if git is available or use the installed
|
|---|
| 194 | version if available. If you need profiling, remove this option.
|
|---|
| 195 | </para>
|
|---|
| 196 |
|
|---|
| 197 | </sect2>
|
|---|
| 198 |
|
|---|
| 199 | <sect2 role="content">
|
|---|
| 200 | <title>Contents</title>
|
|---|
| 201 |
|
|---|
| 202 | <segmentedlist>
|
|---|
| 203 | <segtitle>Installed Programs</segtitle>
|
|---|
| 204 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 205 | <segtitle>Installed Directories</segtitle>
|
|---|
| 206 |
|
|---|
| 207 | <seglistitem>
|
|---|
| 208 | <seg>
|
|---|
| 209 | None
|
|---|
| 210 | </seg>
|
|---|
| 211 | <seg>
|
|---|
| 212 | libsoup-2.4.so and libsoup-gnome-2.4.so
|
|---|
| 213 | </seg>
|
|---|
| 214 | <seg>
|
|---|
| 215 | /usr/include/libsoup-2.4,
|
|---|
| 216 | /usr/include/libsoup-gnome-2.4 and
|
|---|
| 217 | /usr/share/gtk-doc/html/libsoup-2.4 <!-- only installed if -Ddoc=true is
|
|---|
| 218 | passed. -->
|
|---|
| 219 | </seg>
|
|---|
| 220 | </seglistitem>
|
|---|
| 221 | </segmentedlist>
|
|---|
| 222 |
|
|---|
| 223 | <variablelist>
|
|---|
| 224 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 225 | <?dbfo list-presentation="list"?>
|
|---|
| 226 | <?dbhtml list-presentation="table"?>
|
|---|
| 227 |
|
|---|
| 228 | <varlistentry id="libsoup-2">
|
|---|
| 229 | <term><filename class="libraryfile">libsoup-2.4.so</filename></term>
|
|---|
| 230 | <listitem>
|
|---|
| 231 | <para>
|
|---|
| 232 | provides functions for asynchronous HTTP connections
|
|---|
| 233 | </para>
|
|---|
| 234 | <indexterm zone="libsoup libsoup-2">
|
|---|
| 235 | <primary sortas="c-libsoup-2">libsoup-2.4.so</primary>
|
|---|
| 236 | </indexterm>
|
|---|
| 237 | </listitem>
|
|---|
| 238 | </varlistentry>
|
|---|
| 239 |
|
|---|
| 240 | <varlistentry id="libsoup-gnome-2">
|
|---|
| 241 | <term><filename class="libraryfile">libsoup-gnome-2.4.so</filename></term>
|
|---|
| 242 | <listitem>
|
|---|
| 243 | <para>
|
|---|
| 244 | provides <application>GNOME</application> specific features
|
|---|
| 245 | </para>
|
|---|
| 246 | <indexterm zone="libsoup libsoup-gnome-2">
|
|---|
| 247 | <primary sortas="c-libsoup-gnome-2">libsoup-gnome-2.4.so</primary>
|
|---|
| 248 | </indexterm>
|
|---|
| 249 | </listitem>
|
|---|
| 250 | </varlistentry>
|
|---|
| 251 |
|
|---|
| 252 | </variablelist>
|
|---|
| 253 |
|
|---|
| 254 | </sect2>
|
|---|
| 255 |
|
|---|
| 256 | </sect1>
|
|---|
