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