source: x/lib/qtwebengine.xml@ 05b66d9a

10.0 10.1 11.0 11.1 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 05b66d9a was 05b66d9a, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to qt-5.12.2 and qtwebengine-5.12.2

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21336 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 13.8 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 qtwebengine-major "5.12">
8 <!ENTITY qtwebengine-download-http "https://download.qt.io/archive/qt/&qtwebengine-major;/&qtwebengine-version;/submodules/qtwebengine-everywhere-src-&qtwebengine-version;.tar.xz">
9 <!ENTITY qtwebengine-download-ftp " ">
10 <!ENTITY qtwebengine-md5sum "a5182f10645103b54a35f8611fd13506">
11 <!ENTITY qtwebengine-size "238 MB">
12 <!ENTITY qtwebengine-buildsize "3.2 GB (133 MB installed)">
13 <!ENTITY qtwebengine-time "51 SBU (using 4 cores)">
14]>
15
16<sect1 id="qtwebengine" xreflabel="qtwebengine-&qtwebengine-version;">
17 <?dbhtml filename="qtwebengine.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>QtWebEngine-&qtwebengine-version;</title>
25
26 <indexterm zone="qtwebengine">
27 <primary sortas="a-qtwebengine">qtwebengine</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to QtWebEngine</title>
32
33 <para>
34 <application>QtWebEngine</application> integrates
35 <application>chromium</application>'s web capabilities into Qt. It
36 ships with its own copy of ninja which it uses for the build if it cannot
37 find a system copy, and various copies of libraries from ffmpeg, icu,
38 libvpx, and zlib (including libminizip) which have been forked by the
39 <application>chromium</application> developers.
40 </para>
41
42 &lfs84_checked;
43
44 <note>
45 <para>
46 By default, ninja will use all online CPUs +2 (if at least 4 exist),
47 even if they are not available to the current task because the build
48 terminal has been restricted with 'taskset'. To work around this, see
49 the Command Explanations below.
50 </para>
51
52 <para>
53 Unusually, the shipped GN build system (used to create the Ninja files)
54 requires a static <filename class="libraryfile">libstdc++.a</filename>
55 although the installed libraries correctly use the shared version. If
56 that static library is not present, the build will fail quite quickly.
57 Please note that if you try to build webengine as part of
58 <application>Qt</application> and the static library is not available,
59 that build will either complete without installing webengine, or else fail
60 during the install (both variants have been observed in 5.12.0).
61 </para>
62 </note>
63
64 <bridgehead renderas="sect3">Package Information</bridgehead>
65 <itemizedlist spacing="compact">
66 <listitem>
67 <para>
68 Download (HTTP): <ulink url="&qtwebengine-download-http;"/>
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Download (FTP): <ulink url="&qtwebengine-download-ftp;"/>
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Download MD5 sum: &qtwebengine-md5sum;
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Download size: &qtwebengine-size;
84 </para>
85 </listitem>
86 <listitem>
87 <para>
88 Estimated disk space required: &qtwebengine-buildsize;
89 </para>
90 </listitem>
91 <listitem>
92 <para>
93 Estimated build time: &qtwebengine-time;
94 </para>
95 </listitem>
96 </itemizedlist>
97
98<!-- The patch is not needed anymore for 5.12.1
99 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
100 <itemizedlist spacing="compact">
101 <listitem>
102 <para>
103 Required patch (if building on i686):
104 <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-i686_alignof_fix-1.patch"/>
105 </para>
106 </listitem>
107 </itemizedlist>
108-->
109 <bridgehead renderas="sect3">qtwebengine Dependencies</bridgehead>
110
111 <bridgehead renderas="sect4">Required</bridgehead>
112 <!-- the qmake output tends to be misleading. 'khr' is from Mesa -->
113 <para role="required">
114 <xref linkend="nss"/>,
115 <xref linkend="python2"/>, and
116 <xref linkend='qt5'/>
117 </para>
118
119 <bridgehead renderas="sect4">Recommended</bridgehead>
120 <note>
121 <para>
122 If these packages are not installed, the build process will compile and
123 install its own (perhaps older) version, with the side effect of
124 increasing build and installed disk space and build time.
125 </para>
126 </note>
127
128 <para role="recommended">
129 either <xref linkend="alsa-lib"/> or
130 <xref linkend="pulseaudio"/> (or both),
131 <xref linkend="ffmpeg"/>,
132 <xref linkend="icu"/>,
133 <xref linkend="libwebp"/>,
134 <xref linkend="libxslt"/>, and
135 <xref linkend="opus"/>
136 </para>
137
138 <bridgehead renderas="sect4">Optional</bridgehead>
139 <para role="optional">
140 <xref linkend="libevent"/>,
141 <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
142 <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
143 <ulink url="http://google.github.io/snappy/">snappy</ulink>
144 </para>
145
146 <para condition="html" role="usernotes">
147 User Notes: <ulink url="&blfs-wiki;/qtwebengine"/>
148 </para>
149 </sect2>
150
151 <sect2 role="installation">
152 <title>Installation of qtwebengine</title>
153
154 <para>
155 First, ensure that the local headers are available when not building as
156 part of the complete <xref linkend="qt5"/>:
157 </para>
158
159<screen><userinput>find -type f -name "*.pr[io]" |
160 xargs sed -i -e 's|INCLUDEPATH += |&amp;$$QTWEBENGINE_ROOT/include |'</userinput></screen>
161
162 <para>
163 If an older version of the package's main library has been installed,
164 when the package is built separately it will link to that in preference
165 to its own not-yet-installed version, and fail because of missing symbols.
166 Prevent that by, as the <systemitem class="username">root</systemitem>
167 user, moving the symlink out of the way.:
168 </para>
169
170<screen role="root"><userinput>
171if [ -e ${QT5DIR}/lib/libQtWebEngineCore.so ]; then
172 mv -v ${QT5DIR}/lib/libQtWebEngineCore.so{,.old}
173fi</userinput></screen>
174
175<!-- Not needed for 5.12.1
176 <para>
177 If you are building on a 32-bit i686 system, GCC changed the alignof
178 operator to optimize the ABI. Unfortunately, this makes the alignof()
179 operator return an incorrect number (4 instead of 8). Apply a patch to
180 fix this:
181 </para>
182
183<screen><userinput>patch -Np1 -i ../qtwebengine-&qtwebengine-version;-i686_alignof_fix-1.patch</userinput></screen>
184-->
185 <para>
186 Install <application>qtwebengine</application> by running the following
187 commands:
188 </para>
189
190<screen><userinput>mkdir build &amp;&amp;
191cd build &amp;&amp;
192
193qmake .. -- -system-ffmpeg -webengine-icu &amp;&amp;
194make</userinput></screen>
195<!--
196 <para>
197 if you wish to build the HTML documentation, issue:
198 </para>
199
200<screen><userinput>make docs</userinput></screen>
201-->
202 <para>
203 This package does not come with a test suite.
204 </para>
205
206 <para>
207 Now, as the <systemitem class="username">root</systemitem> user:
208 </para>
209
210<screen role="root"><userinput>make install</userinput></screen>
211<!--
212 <para>
213 If you built the HTML documentation, install it with:
214 </para>
215
216<screen role="root"><userinput>make install_docs</userinput></screen>
217-->
218 <para>
219 Remove references to the build directory from installed library
220 dependency (prl) files by running the following
221 commands as the <systemitem class="username">root</systemitem> user:
222 </para>
223
224<screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
225 -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
226 </sect2>
227
228 <sect2 role="commands">
229 <title>Command Explanations</title>
230
231 <para>
232 <command>qmake</command>: This will build the included copy of
233 <application>ninja</application> if it is not already installed
234 and use it to configure the build.
235 </para>
236
237 <para>
238 <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
239 passed to qmake they must come after '--' which must follow '..' that points
240 to the main directory. The options here cause it to use system ffmpeg and
241 system icu. If built as part of full Qt5, the system icu is automatically
242 used (only) by Qt5Core if it is available, but unless this option is used
243 webengine will always use its shipped copy of icu, adding time and space
244 to the build.
245 </para>
246
247 <para>
248 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
249 recognize the NINJAJOBS environment variable, this command will run system
250 ninja with the specified number of jobs (i.e. 4).
251 There are several reasons why you might want to do this:</para>
252
253 <itemizedlist>
254 <listitem>
255 <para> Building on a subset of CPUs allows measuring the build time
256 for that number of processors or to run other CPU-intensive tasks on
257 other cores.</para>
258 </listitem>
259 <listitem>
260 <para>Improving the build speed on a less-well endowed 4-core
261 machine. On a machine with a powerful CPU and plenty of RAM, running
262 N+2 jobs (the ninja default for 4+ cores) for the large working sets
263 of the C++ compiles in this package is typically only marginally
264 faster than running N jobs at a time. But for a machine with less
265 memory it can be much slower.</para>
266 </listitem>
267 <listitem>
268 <para>Reducing the number of cores being used on long running, CPU
269 intensive packages may alleviate heat problems.</para>
270 </listitem>
271 </itemizedlist>
272
273 </sect2>
274
275 <sect2 role="configuration">
276 <title>Configuring QtWebEngine</title>
277
278 <sect3 id="qtwebengine-config">
279 <title>Configuration Information</title>
280
281 <para>
282 If you are upgrading from an older minor version of this
283 application, for some webpages to load you may need to
284 clear the <emphasis>browser</emphasis> caches, e.g. for
285 <application>falkon</application> they will be found in
286 <filename class="directory">~/.cache/falkon/</filename>.
287 You will need to do this if the browser starts to render
288 the page and then changes to a blank tab with a message
289 that something went wrong, and a button to Retry. Even
290 after removing the old caches, you may need to retry a
291 few times for each affected tab.
292 </para>
293
294 </sect3>
295
296 </sect2>
297
298
299 <sect2 role="content">
300 <title>Contents</title>
301
302 <segmentedlist>
303 <segtitle>Installed Programs</segtitle>
304 <segtitle>Installed Libraries</segtitle>
305 <segtitle>Installed Directories</segtitle>
306
307 <seglistitem>
308 <seg>
309 qtwebengine_convert_dict and
310 QtWebEngineProcess
311 </seg>
312 <seg>
313 libQt5WebEngineCore.so,
314 libQt5WebEngine.so, and
315 libQt5WebEngineWidgets.so
316 </seg>
317 <seg>
318 $QT5PREFIX/doc/qtwebengine,
319 $QT5PREFIX/includeQtWebEngine,
320 $QT5PREFIX/include/QtWebEngineCore, and
321 $QT5PREFIX/include/QtWebEngineWidgets
322 </seg>
323 </seglistitem>
324 </segmentedlist>
325
326 <variablelist>
327 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
328 <?dbfo list-presentation="list"?>
329 <?dbhtml list-presentation="table"?>
330
331 <varlistentry id="qtwebengine_convert_dict">
332 <term><command>qtwebengine_convert_dict</command></term>
333 <listitem>
334 <para>
335 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
336 format (<literal>.bdic</literal>)
337 </para>
338 <indexterm zone="qtwebengine qtwebengine_convert_dict">
339 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="QtWebEngineProcess">
345 <term><command>QtWebEngineProcess</command></term>
346 <listitem>
347 <para>
348 is a libexec program which runs a zygote process (one that listens
349 for spawn requests from a master process and will fork itself in
350 response).
351 </para>
352 <indexterm zone="qtwebengine QtWebEngineProcess">
353 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="libQtWebEngine-lib">
359 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
360 <listitem>
361 <para>
362 provides QML types for rendering web content within a QML application.
363 </para>
364 <indexterm zone="qtwebengine libQtWebEngine-lib">
365 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="libQtWebEngineCore">
371 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
372 <listitem>
373 <para>
374 provides public API shared by both QtWebEngine and QtWebEngineWidgets.
375 </para>
376 <indexterm zone="qtwebengine libQtWebEngineCore">
377 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="libQtWebEngineWidgets">
383 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
384 <listitem>
385 <para>
386 provides a web browser engine as well as C++ classes to render and
387 interact with web content.
388 </para>
389 <indexterm zone="qtwebengine libQtWebEngineWidgets">
390 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 </variablelist>
396 </sect2>
397</sect1>
Note: See TracBrowser for help on using the repository browser.