source: x/lib/qtwebengine.xml@ e10e1a8e

10.0 10.1 11.0 11.1 11.2 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since e10e1a8e was e10e1a8e, checked in by Pierre Labastie <pieere@…>, 3 years ago

MIT Kerberos V5-1.17.1
Qt5-5.14.0
Qtwebengine-5.14.0

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

  • Property mode set to 100644
File size: 15.7 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.14">
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 "a6765a7674728f6a3326de21937f9a94">
11 <!ENTITY qtwebengine-size "230 MB">
12 <!ENTITY qtwebengine-buildsize "3.6 GB (146 MB installed)">
13 <!ENTITY qtwebengine-time "63 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 &lfs90_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 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
99 <itemizedlist spacing="compact">
100 <listitem>
101 <para>
102 Required patch:
103 <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-background_rendering_fix-1.patch"/>
104 </para>
105 </listitem>
106 </itemizedlist>
107-->
108 <bridgehead renderas="sect3">qtwebengine Dependencies</bridgehead>
109
110 <bridgehead renderas="sect4">Required</bridgehead>
111 <!-- the qmake output tends to be misleading. 'khr' is from Mesa -->
112 <para role="required">
113 <xref linkend="nss"/>,
114 <xref linkend="python2"/>, and
115 <xref linkend='qt5'/>
116 </para>
117
118 <bridgehead renderas="sect4">Recommended</bridgehead>
119 <note>
120 <para>
121 If these packages are not installed, the build process will compile and
122 install its own (perhaps older) version, with the side effect of
123 increasing build and installed disk space and build time.
124 </para>
125 </note>
126
127 <para role="recommended">
128 either <xref linkend="alsa-lib"/> or
129 <xref linkend="pulseaudio"/> (or both),
130 <xref linkend="ffmpeg"/>,
131 <xref linkend="Jinja2"/> (Python 2 module),
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 <xref linkend="poppler"/>,
142 <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
143 <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
144 <ulink url="http://google.github.io/snappy/">snappy</ulink>
145 </para>
146
147 <para condition="html" role="usernotes">
148 User Notes: <ulink url="&blfs-wiki;/qtwebengine"/>
149 </para>
150 </sect2>
151
152 <sect2 role="installation">
153 <title>Installation of qtwebengine</title>
154
155 <para>
156 First, ensure that the local headers are available when not building as
157 part of the complete <xref linkend="qt5"/>:
158 </para>
159
160<screen><userinput>find -type f -name "*.pr[io]" |
161 xargs sed -i -e 's|INCLUDEPATH += |&amp;$$QTWEBENGINE_ROOT/include |'</userinput></screen>
162<!--
163 <para>
164 Next, apply a patch that fixes background rendering issues in Falkon,
165 and crashes on multimedia-heavy sites.
166 </para>
167
168<screen><userinput remap="pre">patch -Np1 -i ../qtwebengine-&qtwebengine-version;-background_rendering_fix-1.patch</userinput></screen>
169-->
170
171 <para>
172 Next, fix a critical zero-day vulnerability in the audio subsystem:
173 </para>
174
175<screen><userinput remap="pre">sed -e '/!buffer/a \
176\ BaseAudioContext::GraphAutoLocker context_locker(Context()); \
177\ MutexLocker locker(process_lock_);' -i \
178 src/3rdparty/chromium/third_party/blink/renderer/modules/webaudio/convolver_node.cc</userinput></screen>
179
180 <para>
181 Next, allow the pulseaudio library to be linked at build time, instead
182 of run time. This also prevents an issue with newer pulseaudio:
183 </para>
184
185<screen><userinput>sed -e '/link_pulseaudio/s/false/true/' \
186 -i src/3rdparty/chromium/media/media_options.gni</userinput></screen>
187
188 <para>
189 Now add a terminating semicolon to a macro to let it compile with
190 <xref linkend="icu"/>:
191 </para>
192
193<!-- editors: this line number is specific to 5.13.2, later versions might
194have already been fixed, or more likely the relevant line is no longer 5713.
195There are two lines which invoke U16_NOTE(), the first already has a ';'
196followed by a comment, the second lacks the ';' -->
197
198<screen><userinput>sed -i '5713s/.*/&amp;;/' \
199 src/3rdparty/chromium/third_party/blink/renderer/core/dom/document.cc</userinput></screen>
200
201 <para>
202 Finally, fix a change in the build system which allows its developers to
203 pass e.g. -j20 to make (for quick tests of some areas) but breaks the
204 build with LFS's use of the NINJAJOBS environment variable:
205 </para>
206
207<!-- editors: See thread at
208http://lists.linuxfromscratch.org/pipermail/blfs-dev/2019-December/036996.html
209et.seq, particularly 037002.html which shows the commit near the end. -->
210
211<screen><userinput>sed -i 's/NINJAJOBS/NINJA_JOBS/' src/core/gn_run.pro</userinput></screen>
212
213 <para>
214 If an older version of the package's main library has been installed,
215 when the package is built separately it will link to that in preference
216 to its own not-yet-installed version, and fail because of missing symbols.
217 Prevent that by, as the <systemitem class="username">root</systemitem>
218 user, moving the symlink out of the way.:
219 </para>
220
221<screen role="root"><userinput>if [ -e ${QT5DIR}/lib/libQt5WebEngineCore.so ]; then
222 mv -v ${QT5DIR}/lib/libQt5WebEngineCore.so{,.old}
223fi</userinput></screen>
224
225 <para>
226 Install <application>qtwebengine</application> by running the following
227 commands:
228 </para>
229
230<screen><userinput>mkdir build &amp;&amp;
231cd build &amp;&amp;
232
233qmake .. -- -system-ffmpeg -webengine-icu &amp;&amp;
234make</userinput></screen>
235<!--
236 <para>
237 if you wish to build the HTML documentation, issue:
238 </para>
239
240<screen><userinput>make docs</userinput></screen>
241-->
242 <para>
243 This package does not come with a test suite.
244 </para>
245
246 <para>
247 Now, as the <systemitem class="username">root</systemitem> user:
248 </para>
249
250<screen role="root"><userinput>make install</userinput></screen>
251 <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
252 instead of DESTDIR= -->
253<!--
254 <para>
255 If you built the HTML documentation, install it with:
256 </para>
257
258<screen role="root"><userinput>make install_docs</userinput></screen>
259-->
260 <para>
261 Remove references to the build directory from installed library
262 dependency (prl) files by running the following
263 commands as the <systemitem class="username">root</systemitem> user:
264 </para>
265
266<screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
267 -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
268 </sect2>
269
270 <sect2 role="commands">
271 <title>Command Explanations</title>
272
273 <para>
274 <command>qmake</command>: This will build the included copy of
275 <application>ninja</application> if it is not already installed
276 and use it to configure the build.
277 </para>
278
279 <para>
280 <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
281 passed to qmake they must come after '--' which must follow '..' that points
282 to the main directory. The options here cause it to use system ffmpeg and
283 system icu. If built as part of full Qt5, the system icu is automatically
284 used (only) by Qt5Core if it is available, but unless this option is used
285 webengine will always use its shipped copy of icu, adding time and space
286 to the build.
287 </para>
288
289 <!--
290 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
291 href="../../xincludes/SIOCGSTAMP.xml"/>
292 -->
293
294 <para>
295 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
296 recognize the NINJAJOBS environment variable, this command will run system
297 ninja with the specified number of jobs (i.e. 4).
298 There are several reasons why you might want to do this:</para>
299
300 <itemizedlist>
301 <listitem>
302 <para> Building on a subset of CPUs allows measuring the build time
303 for that number of processors or to run other CPU-intensive tasks on
304 other cores.</para>
305 </listitem>
306 <listitem>
307 <para>Improving the build speed on a less-well endowed 4-core
308 machine. On a machine with a powerful CPU and plenty of RAM, running
309 N+2 jobs (the ninja default for 4+ cores) for the large working sets
310 of the C++ compiles in this package is typically only marginally
311 faster than running N jobs at a time. But for a machine with less
312 memory it can be much slower.</para>
313 </listitem>
314 <listitem>
315 <para>Reducing the number of cores being used on long running, CPU
316 intensive packages may alleviate heat problems.</para>
317 </listitem>
318 </itemizedlist>
319
320 </sect2>
321
322 <sect2 role="configuration">
323 <title>Configuring QtWebEngine</title>
324
325 <sect3 id="qtwebengine-config">
326 <title>Configuration Information</title>
327
328 <para>
329 If you are upgrading from an older minor version of this
330 application, for some webpages to load you may need to
331 clear the <emphasis>browser</emphasis> caches, e.g. for
332 <application>falkon</application> they will be found in
333 <filename class="directory">~/.cache/falkon/</filename>.
334 You will need to do this if the browser starts to render
335 the page and then changes to a blank tab with a message
336 that something went wrong, and a button to Retry. Even
337 after removing the old caches, you may need to retry a
338 few times for each affected tab.
339 </para>
340
341 </sect3>
342
343 </sect2>
344
345
346 <sect2 role="content">
347 <title>Contents</title>
348
349 <segmentedlist>
350 <segtitle>Installed Programs</segtitle>
351 <segtitle>Installed Libraries</segtitle>
352 <segtitle>Installed Directories</segtitle>
353
354 <seglistitem>
355 <seg>
356 qtwebengine_convert_dict and
357 QtWebEngineProcess (in $QT5DIR/libexec)
358 </seg>
359 <seg>
360 libQt5WebEngineCore.so,
361 libQt5WebEngine.so, and
362 libQt5WebEngineWidgets.so
363 </seg>
364 <seg>
365 $QT5DIR/include/QtWebEngine,
366 $QT5DIR/include/QtWebEngineCore,
367 $QT5DIR/include/QtWebEngineWidgets,
368 $QT5DIR/qml/QtWebEngine, and
369 $QT5DIR/translations/qtwebengine_locales
370 </seg>
371 </seglistitem>
372 </segmentedlist>
373
374 <variablelist>
375 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
376 <?dbfo list-presentation="list"?>
377 <?dbhtml list-presentation="table"?>
378
379 <varlistentry id="qtwebengine_convert_dict">
380 <term><command>qtwebengine_convert_dict</command></term>
381 <listitem>
382 <para>
383 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
384 format (<literal>.bdic</literal>)
385 </para>
386 <indexterm zone="qtwebengine qtwebengine_convert_dict">
387 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="QtWebEngineProcess">
393 <term><command>QtWebEngineProcess</command></term>
394 <listitem>
395 <para>
396 is a libexec program which runs a zygote process (one that listens
397 for spawn requests from a master process and will fork itself in
398 response).
399 </para>
400 <indexterm zone="qtwebengine QtWebEngineProcess">
401 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="libQtWebEngine-lib">
407 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
408 <listitem>
409 <para>
410 provides QML types for rendering web content within a QML application.
411 </para>
412 <indexterm zone="qtwebengine libQtWebEngine-lib">
413 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="libQtWebEngineCore">
419 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
420 <listitem>
421 <para>
422 provides public API shared by both QtWebEngine and QtWebEngineWidgets.
423 </para>
424 <indexterm zone="qtwebengine libQtWebEngineCore">
425 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="libQtWebEngineWidgets">
431 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
432 <listitem>
433 <para>
434 provides a web browser engine as well as C++ classes to render and
435 interact with web content.
436 </para>
437 <indexterm zone="qtwebengine libQtWebEngineWidgets">
438 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 </variablelist>
444 </sect2>
445</sect1>
Note: See TracBrowser for help on using the repository browser.