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 libsoup3-download-http
|
---|
8 | "&gnome-download-http;/libsoup/&libsoup3-minor;/libsoup-&libsoup3-version;.tar.xz">
|
---|
9 | <!ENTITY libsoup3-download-ftp " ">
|
---|
10 | <!ENTITY libsoup3-md5sum "a63ea04a9686e9e4470b127ffe1eb96b">
|
---|
11 | <!ENTITY libsoup3-size "1.5 MB">
|
---|
12 | <!ENTITY libsoup3-buildsize "38 MB (with tests)">
|
---|
13 | <!ENTITY libsoup3-time "0.3 SBU (Using parallelism=4; with tests)">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="libsoup3" xreflabel="libsoup-&libsoup3-version;">
|
---|
17 | <?dbhtml filename="libsoup3.html"?>
|
---|
18 |
|
---|
19 |
|
---|
20 | <title>libsoup-&libsoup3-version;</title>
|
---|
21 |
|
---|
22 | <indexterm zone="libsoup3">
|
---|
23 | <primary sortas="a-libsoup3">libsoup3</primary>
|
---|
24 | </indexterm>
|
---|
25 |
|
---|
26 | <sect2 role="package">
|
---|
27 | <title>Introduction to libsoup3</title>
|
---|
28 |
|
---|
29 | <para>
|
---|
30 | The <application>libsoup3</application> is a HTTP client/server library for
|
---|
31 | <application>GNOME</application>. It uses GObject and the GLib main loop
|
---|
32 | to integrate with <application>GNOME</application> applications and
|
---|
33 | it also has an asynchronous API for use in threaded applications.
|
---|
34 | </para>
|
---|
35 |
|
---|
36 | &lfs122_checked;
|
---|
37 |
|
---|
38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
39 | <itemizedlist spacing="compact">
|
---|
40 | <listitem>
|
---|
41 | <para>
|
---|
42 | Download (HTTP): <ulink url="&libsoup3-download-http;"/>
|
---|
43 | </para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (FTP): <ulink url="&libsoup3-download-ftp;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download MD5 sum: &libsoup3-md5sum;
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download size: &libsoup3-size;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Estimated disk space required: &libsoup3-buildsize;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated build time: &libsoup3-time;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | </itemizedlist>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect3">libsoup3 Dependencies</bridgehead>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
75 | <para role="required">
|
---|
76 | <xref linkend="glib-networking"/>,
|
---|
77 | <xref linkend="libpsl"/>,
|
---|
78 | <xref linkend="libxml2"/>,
|
---|
79 | <xref linkend="nghttp2"/>, and
|
---|
80 | <xref linkend="sqlite"/>
|
---|
81 | </para>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
84 | <para role="recommended">
|
---|
85 | &gobject-introspection; and
|
---|
86 | <xref linkend="vala"/>
|
---|
87 | </para>
|
---|
88 |
|
---|
89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
90 | <para role="optional">
|
---|
91 | <xref linkend="apache"/> (required to run the test suite),
|
---|
92 | <xref linkend="brotli"/>,
|
---|
93 | <xref linkend="curl"/> (required to run the test suite),
|
---|
94 | <xref linkend="gi-docgen"/>,
|
---|
95 | <xref linkend="mitkrb"/> (required to run the test suite),
|
---|
96 | <!-- It seems that XMLRPC is part of PHP 5.4.10 -->
|
---|
97 | <xref linkend="php"/> compiled with XMLRPC-EPI
|
---|
98 | support (only used for the XMLRPC regression tests),
|
---|
99 | <xref linkend="samba"/> (ntlm_auth is required to run the test suite),
|
---|
100 | <!--<xref linkend="sysprof"/> (for profiling),-->
|
---|
101 | <ulink url="&sysprof-url;">sysprof</ulink>, and
|
---|
102 | <ulink url="https://github.com/posener/wstest">wstest</ulink>
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="installation">
|
---|
108 | <title>Installation of libsoup3</title>
|
---|
109 |
|
---|
110 | <para>
|
---|
111 | Fix the installation path of API documentation:
|
---|
112 | </para>
|
---|
113 |
|
---|
114 | <screen><userinput>sed 's/apiversion/soup_version/' -i docs/reference/meson.build</userinput></screen>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | Install <application>libsoup3</application> by running the following
|
---|
118 | commands:
|
---|
119 | </para>
|
---|
120 |
|
---|
121 | <screen><userinput>mkdir build &&
|
---|
122 | cd build &&
|
---|
123 |
|
---|
124 | meson setup --prefix=/usr \
|
---|
125 | --buildtype=release \
|
---|
126 | -D vapi=enabled \
|
---|
127 | -D gssapi=disabled \
|
---|
128 | -D sysprof=disabled \
|
---|
129 | --wrap-mode=nofallback \
|
---|
130 | .. &&
|
---|
131 | ninja</userinput></screen>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | To test the results, issue: <command>ninja test</command>.
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <para>
|
---|
138 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
139 | </para>
|
---|
140 |
|
---|
141 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="commands">
|
---|
146 | <title>Command Explanations</title>
|
---|
147 |
|
---|
148 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
149 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
150 |
|
---|
151 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
152 | href="../../xincludes/meson-wrap-nofallback.xml"/>
|
---|
153 |
|
---|
154 | <para>
|
---|
155 | <option>-D vapi=disabled</option>: Use this if you have not installed
|
---|
156 | <application>Vala</application>, e.g. because you are not building
|
---|
157 | <application>GNOME</application>.
|
---|
158 | </para>
|
---|
159 |
|
---|
160 | <para>
|
---|
161 | <option>-D docs=enabled</option>: If <xref linkend='gi-docgen'/> is
|
---|
162 | installed, the API documentation will be built and installed no matter
|
---|
163 | if this option is used or not. This option causes the
|
---|
164 | <command>meson</command> command to fail if
|
---|
165 | <xref linkend='gi-docgen'/> is not installed.
|
---|
166 | </para>
|
---|
167 |
|
---|
168 | <para>
|
---|
169 | <parameter>-D gssapi=disabled</parameter>: libsoup3 defaults to building
|
---|
170 | with GSSAPI support, which requires Kerberos (as does the test suite).
|
---|
171 | </para>
|
---|
172 |
|
---|
173 | <para>
|
---|
174 | <parameter>-D sysprof=disabled</parameter>: libsoup3 will automatically
|
---|
175 | download a git version of <ulink url="&sysprof-url;">sysprof</ulink> if
|
---|
176 | git is available or use the installed version if it is present on the
|
---|
177 | system. If you need profiling, remove this option.
|
---|
178 | </para>
|
---|
179 |
|
---|
180 | </sect2>
|
---|
181 |
|
---|
182 | <sect2 role="content">
|
---|
183 | <title>Contents</title>
|
---|
184 |
|
---|
185 | <segmentedlist>
|
---|
186 | <segtitle>Installed Programs</segtitle>
|
---|
187 | <segtitle>Installed Libraries</segtitle>
|
---|
188 | <segtitle>Installed Directories</segtitle>
|
---|
189 |
|
---|
190 | <seglistitem>
|
---|
191 | <seg>
|
---|
192 | None
|
---|
193 | </seg>
|
---|
194 | <seg>
|
---|
195 | libsoup-3.0.so
|
---|
196 | </seg>
|
---|
197 | <seg>
|
---|
198 | /usr/include/libsoup-3.0,
|
---|
199 | /usr/share/doc/libsoup-&libsoup3-version;
|
---|
200 | (only installed if gi-docgen is available)
|
---|
201 | </seg>
|
---|
202 | </seglistitem>
|
---|
203 | </segmentedlist>
|
---|
204 |
|
---|
205 | <variablelist>
|
---|
206 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
207 | <?dbfo list-presentation="list"?>
|
---|
208 | <?dbhtml list-presentation="table"?>
|
---|
209 |
|
---|
210 | <varlistentry id="libsoup-3">
|
---|
211 | <term><filename class="libraryfile">libsoup-3.0.so</filename></term>
|
---|
212 | <listitem>
|
---|
213 | <para>
|
---|
214 | provides functions for asynchronous HTTP connections
|
---|
215 | </para>
|
---|
216 | <indexterm zone="libsoup libsoup-3">
|
---|
217 | <primary sortas="c-libsoup-3">libsoup-3.0.so</primary>
|
---|
218 | </indexterm>
|
---|
219 | </listitem>
|
---|
220 | </varlistentry>
|
---|
221 |
|
---|
222 | </variablelist>
|
---|
223 |
|
---|
224 | </sect2>
|
---|
225 |
|
---|
226 | </sect1>
|
---|