source: networking/netlibs/libsoup3.xml@ 28d1edf

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 28d1edf was 0b4d98d, checked in by Douglas R. Reno <renodr@…>, 9 months ago

Archive sysprof.

It's optional for the packages that use it, and they only use it to
provide additional support for profiling.

Sysprof now requires two more packages which are specific to it, so
let's archive it.

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