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 qtwebengine-download-http "https://download.qt.io/official_releases/qt/&qtwebengine-major;/&qtwebengine-version;/submodules/qtwebengine-everywhere-src-&qtwebengine-version;.tar.xz">
|
---|
8 | <!ENTITY qtwebengine-download-ftp " ">
|
---|
9 | <!ENTITY qtwebengine-md5sum "5d984409b5f1a7e0b302d7904c2d2105">
|
---|
10 | <!ENTITY qtwebengine-size "525 MB">
|
---|
11 | <!ENTITY qtwebengine-buildsize "8.7 GB (335 MB installed)">
|
---|
12 | <!ENTITY qtwebengine-time "36 SBU (Using parallelism=8)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="qtwebengine" xreflabel="qtwebengine-&qtwebengine-version;">
|
---|
16 | <?dbhtml filename="qtwebengine.html"?>
|
---|
17 |
|
---|
18 | <title>QtWebEngine-&qtwebengine-version;</title>
|
---|
19 |
|
---|
20 | <indexterm zone="qtwebengine">
|
---|
21 | <primary sortas="a-qtwebengine">qtwebengine</primary>
|
---|
22 | </indexterm>
|
---|
23 |
|
---|
24 | <sect2 role="package">
|
---|
25 | <title>Introduction to QtWebEngine</title>
|
---|
26 |
|
---|
27 | <para>
|
---|
28 | <application>QtWebEngine</application> integrates
|
---|
29 | <application>chromium</application>'s web capabilities into Qt. It
|
---|
30 | ships with its own copy of ninja which it uses for the build if it cannot
|
---|
31 | find a system copy, and various copies of libraries from ffmpeg, icu,
|
---|
32 | libvpx, and zlib (including libminizip) which have been forked by the
|
---|
33 | <application>chromium</application> developers.
|
---|
34 | </para>
|
---|
35 |
|
---|
36 | <para>
|
---|
37 | This package and browsers using it may be useful if you need to use a
|
---|
38 | website designed for google chrome, or chromium, browsers.
|
---|
39 | </para>
|
---|
40 |
|
---|
41 | <warning>
|
---|
42 | <para>
|
---|
43 | QtWebEngine uses a forked copy of chromium, and is therefore vulnerable
|
---|
44 | to many issues found there. The Qt developers seem to fork a newer
|
---|
45 | version for minor Qt versions, but because chromium moves to newer
|
---|
46 | versions very often, by the time the Qt developers get a forked version
|
---|
47 | to pass their extended tests it is always an old version and security
|
---|
48 | fixes from chromium (some of which have a CVE number) can take several
|
---|
49 | months to appear in a QtWebengine release, even if the severity has been
|
---|
50 | rated as Critical.
|
---|
51 | </para>
|
---|
52 |
|
---|
53 | <para>
|
---|
54 | Therefore, you should be wary of using QtWebEngine in a sensitive
|
---|
55 | context and should always update to the next release as soon as it
|
---|
56 | appears in this book, even if is not flagged as a Security Update.
|
---|
57 | Identifying which vulnerabilities have been fixed in a particular
|
---|
58 | release requires pulling the appropriate 'based-NNN' branch just before
|
---|
59 | the previous and current releases and is often impractical. Reports of
|
---|
60 | fixed QTBUG items do not seem to be available and there is not any
|
---|
61 | documentation in the tarball for changes after the qt-5 versions.
|
---|
62 | </para>
|
---|
63 | </warning>
|
---|
64 |
|
---|
65 | &lfs121_checked;
|
---|
66 |
|
---|
67 | <warning>
|
---|
68 | <para>
|
---|
69 | By default, ninja will use all online CPUs +2 (if at least 4 exist),
|
---|
70 | even if they are not available to the current task because the build
|
---|
71 | terminal has been restricted with 'taskset'. In BLFS, this package
|
---|
72 | takes more time to build than any other. In one example,
|
---|
73 | the build of this package crashed at about the 90 percent point
|
---|
74 | due to an out of memory problem on a system with 24 cores and 32 GB
|
---|
75 | of memory.
|
---|
76 | </para>
|
---|
77 |
|
---|
78 | <para>
|
---|
79 | To work around this, see the Command Explanations below.
|
---|
80 | </para>
|
---|
81 | </warning>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
84 | <itemizedlist spacing="compact">
|
---|
85 | <listitem>
|
---|
86 | <para>
|
---|
87 | Download (HTTP): <ulink url="&qtwebengine-download-http;"/>
|
---|
88 | </para>
|
---|
89 | </listitem>
|
---|
90 | <listitem>
|
---|
91 | <para>
|
---|
92 | Download (FTP): <ulink url="&qtwebengine-download-ftp;"/>
|
---|
93 | </para>
|
---|
94 | </listitem>
|
---|
95 | <listitem>
|
---|
96 | <para>
|
---|
97 | Download MD5 sum: &qtwebengine-md5sum;
|
---|
98 | </para>
|
---|
99 | </listitem>
|
---|
100 | <listitem>
|
---|
101 | <para>
|
---|
102 | Download size: &qtwebengine-size;
|
---|
103 | </para>
|
---|
104 | </listitem>
|
---|
105 | <listitem>
|
---|
106 | <para>
|
---|
107 | Estimated disk space required: &qtwebengine-buildsize;
|
---|
108 | </para>
|
---|
109 | </listitem>
|
---|
110 | <listitem>
|
---|
111 | <para>
|
---|
112 | Estimated build time: &qtwebengine-time;
|
---|
113 | </para>
|
---|
114 | </listitem>
|
---|
115 | </itemizedlist>
|
---|
116 |
|
---|
117 | <!--
|
---|
118 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
119 | <itemizedlist spacing="compact">
|
---|
120 | <listitem>
|
---|
121 | <para>
|
---|
122 | Required patch:
|
---|
123 | <!\-\- keep links for releases and git versions as a reminder
|
---|
124 | that the tarball names names differ
|
---|
125 | <ulink url="&patch-root;/qtwebengine-everywhere-src-&qtwebengine-version;-ICU68-2.patch"/> \-\->
|
---|
126 |
|
---|
127 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-5.15.7-1.patch"/>
|
---|
128 | </para>
|
---|
129 | </listitem>
|
---|
130 | <listitem>
|
---|
131 | <para>
|
---|
132 | Required patch:
|
---|
133 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-build_fixes-2.patch"/>
|
---|
134 | </para>
|
---|
135 | </listitem>
|
---|
136 | <listitem>
|
---|
137 | <para>
|
---|
138 | Required patch:
|
---|
139 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-ffmpeg5_fixes-1.patch"/>
|
---|
140 | </para>
|
---|
141 | </listitem>
|
---|
142 |
|
---|
143 | <listitem>
|
---|
144 | <para>
|
---|
145 | Required patch:
|
---|
146 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-icu_73-1.patch"/>
|
---|
147 | </para>
|
---|
148 | </listitem>
|
---|
149 | </itemizedlist>
|
---|
150 | -->
|
---|
151 |
|
---|
152 | <bridgehead renderas="sect3">qtwebengine Dependencies</bridgehead>
|
---|
153 |
|
---|
154 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
155 |
|
---|
156 | <para role="required">
|
---|
157 | <xref linkend="html5lib"/>,
|
---|
158 | <xref linkend="nodejs"/>,
|
---|
159 | <xref linkend="nss"/>,
|
---|
160 | <xref linkend="pciutils"/>, and
|
---|
161 | <xref linkend='qt6'/>
|
---|
162 | </para>
|
---|
163 |
|
---|
164 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
165 | <note>
|
---|
166 | <para>
|
---|
167 | If these packages are not installed, the build process will compile and
|
---|
168 | install its own (perhaps older) version, with the side effect of
|
---|
169 | increasing build and installed disk space and build time.
|
---|
170 | </para>
|
---|
171 | </note>
|
---|
172 |
|
---|
173 | <para role="recommended">
|
---|
174 | either <xref linkend="alsa-lib"/> or
|
---|
175 | <xref linkend="pulseaudio"/> (or both),
|
---|
176 | <xref linkend="ffmpeg"/>,
|
---|
177 | <xref linkend="icu"/>,
|
---|
178 | <xref linkend="libwebp"/>,
|
---|
179 | <xref linkend="libxslt"/>, and
|
---|
180 | <xref linkend="opus"/>
|
---|
181 | </para>
|
---|
182 |
|
---|
183 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
184 | <para role="optional">
|
---|
185 | <xref linkend="libevent"/>,
|
---|
186 | <xref linkend="mitkrb"/>,
|
---|
187 | <xref linkend="pipewire"/>,
|
---|
188 | <xref linkend="poppler"/>,
|
---|
189 | <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
|
---|
190 | <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
|
---|
191 | <ulink url="https://google.github.io/snappy/">snappy</ulink>
|
---|
192 | </para>
|
---|
193 |
|
---|
194 | </sect2>
|
---|
195 |
|
---|
196 | <sect2 role="installation">
|
---|
197 | <title>Installation of qtwebengine</title>
|
---|
198 | <para>
|
---|
199 | Install <application>qtwebengine</application> by running the following
|
---|
200 | commands:
|
---|
201 | </para>
|
---|
202 |
|
---|
203 |
|
---|
204 | <!-- Note to whoever is updating this next, test to see if it FTBFS/Runtime Errors with
|
---|
205 | system FFMpeg, I can't get it to work on 6.7.0 and FFMpeg 7.0 [rahul] -->
|
---|
206 | <screen><userinput>mkdir build &&
|
---|
207 | cd build &&
|
---|
208 |
|
---|
209 | cmake -D CMAKE_MESSAGE_LOG_LEVEL=STATUS \
|
---|
210 | -D QT_FEATURE_webengine_system_ffmpeg=OFF \
|
---|
211 | -D QT_FEATURE_webengine_system_icu=ON \
|
---|
212 | -D QT_FEATURE_webengine_system_libevent=ON \
|
---|
213 | -D QT_FEATURE_webengine_proprietary_codecs=ON \
|
---|
214 | -D QT_FEATURE_webengine_webrtc_pipewire=ON \
|
---|
215 | -D QT_BUILD_EXAMPLES_BY_DEFAULT=OFF \
|
---|
216 | -G Ninja .. &&
|
---|
217 |
|
---|
218 | ninja</userinput></screen>
|
---|
219 |
|
---|
220 | <para>
|
---|
221 | This package does not come with a test suite.
|
---|
222 | </para>
|
---|
223 |
|
---|
224 | <para>
|
---|
225 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
226 | </para>
|
---|
227 |
|
---|
228 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
229 |
|
---|
230 | <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
|
---|
231 | instead of DESTDIR= Not sure this is valid any more with version 6.6.2 -->
|
---|
232 | </sect2>
|
---|
233 |
|
---|
234 | <sect2 role="commands">
|
---|
235 | <title>Command Explanations</title>
|
---|
236 |
|
---|
237 | <para>
|
---|
238 | <parameter>CMAKE_MESSAGE_LOG_LEVEL=STATUS</parameter>: Output
|
---|
239 | interesting messages that project users might be interested in.
|
---|
240 | Ideally these should be concise, no more than a single line,
|
---|
241 | but still informative.
|
---|
242 | </para>
|
---|
243 |
|
---|
244 | <para>
|
---|
245 | <parameter>QT_FEATURE_webengine_system_*</parameter>: Specify what
|
---|
246 | external packages the system should use.
|
---|
247 | </para>
|
---|
248 |
|
---|
249 | <para>
|
---|
250 | <parameter>QT_BUILD_EXAMPLES_BY_DEFAULT=OFF</parameter>: Do not build
|
---|
251 | examples by default.
|
---|
252 | </para>
|
---|
253 |
|
---|
254 | <para>
|
---|
255 | <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
|
---|
256 | recognize the NINJAJOBS environment variable, this command will run system
|
---|
257 | ninja with the specified number of jobs (i.e. 4).
|
---|
258 | There are several reasons why you might want to use options like this this:
|
---|
259 | </para>
|
---|
260 |
|
---|
261 | <itemizedlist>
|
---|
262 | <listitem>
|
---|
263 | <para>
|
---|
264 | Building on a subset of CPUs allows measuring the build time
|
---|
265 | for a smaller number of processors, and/or running other
|
---|
266 | CPU-intensive tasks at the same time. For an editor on a machine
|
---|
267 | with a lot of CPUs, trying to measure the build time for a 4-CPU
|
---|
268 | machine, <option>NINJAJOBS=4 make</option> will give a reasonable
|
---|
269 | approximation (there is a short period where N+2 python and node
|
---|
270 | jobs run).
|
---|
271 | </para>
|
---|
272 | </listitem>
|
---|
273 | <listitem>
|
---|
274 | <para>
|
---|
275 | On a machine with only 4 CPUs online, the default of scheduling
|
---|
276 | N+2 jobs for qtwebengine is slower by between 3% and 7%, probably
|
---|
277 | because of the size of the C++ files and their many includes and
|
---|
278 | templates. Therefore, if in doubt set NINJAJOBS to the number of CPUs.
|
---|
279 | </para>
|
---|
280 | </listitem>
|
---|
281 | <listitem>
|
---|
282 | <para>
|
---|
283 | Reducing the number of cores being used on long running, CPU
|
---|
284 | intensive packages may alleviate heat problems.
|
---|
285 | </para>
|
---|
286 | </listitem>
|
---|
287 | <listitem>
|
---|
288 | <para>
|
---|
289 | Reducing the number of cores will prevent potential out-of-memory
|
---|
290 | problems on systems that do not have enough memory (or swap)
|
---|
291 | when all cores are active. A suggested approach is to limit
|
---|
292 | the number of cores to about one core for each 1.5 GB of
|
---|
293 | combined RAM and swap space.
|
---|
294 | </para>
|
---|
295 | </listitem>
|
---|
296 | </itemizedlist>
|
---|
297 |
|
---|
298 | </sect2>
|
---|
299 |
|
---|
300 | <sect2 role="configuration">
|
---|
301 | <title>Configuring QtWebEngine</title>
|
---|
302 |
|
---|
303 | <sect3 id="qtwebengine-config">
|
---|
304 | <title>Configuration Information</title>
|
---|
305 |
|
---|
306 | <para>
|
---|
307 | If you are upgrading from an older minor version of this
|
---|
308 | application, for some webpages to load you may need to
|
---|
309 | clear the <emphasis>browser</emphasis> caches, e.g. for
|
---|
310 | <application>falkon</application> they will be found in
|
---|
311 | <filename class="directory">~/.cache/falkon/</filename>.
|
---|
312 | You will need to do this if the browser starts to render
|
---|
313 | the page and then changes to a blank tab with a message
|
---|
314 | that something went wrong, and a button to Retry. Even
|
---|
315 | after removing the old caches, you may need to retry a
|
---|
316 | few times for each affected tab.
|
---|
317 | </para>
|
---|
318 |
|
---|
319 | <para>
|
---|
320 | If a browser using this package fails to run and when run
|
---|
321 | from a term it reports 'Trace/breakpoint trap' that is
|
---|
322 | probably a kernel configuration issue - there is no need
|
---|
323 | to rebuild QtWebEngine, see the next section, recompile
|
---|
324 | the kernel and reboot to the new kernel.
|
---|
325 | </para>
|
---|
326 |
|
---|
327 | </sect3>
|
---|
328 |
|
---|
329 | </sect2>
|
---|
330 |
|
---|
331 | <sect2 role="kernel" id="qtwebengine-kernel">
|
---|
332 | <title>Kernel Configuration</title>
|
---|
333 |
|
---|
334 | <para>
|
---|
335 | This package does not require any of the optional kernel namespace items,
|
---|
336 | but if User namespace is enabled <phrase revision="systemd">(as happens
|
---|
337 | in some unit files, for hardening)</phrase> PID namespace must also be
|
---|
338 | enabled. In that case enable the following options in the kernel
|
---|
339 | configuration and recompile the kernel if necessary:
|
---|
340 | </para>
|
---|
341 |
|
---|
342 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
343 | href="qtwebengine-kernel.xml"/>
|
---|
344 |
|
---|
345 | <indexterm zone="qtwebengine qtwebengine-kernel">
|
---|
346 | <primary sortas="d-qtwebengine">qtwebengine</primary>
|
---|
347 | </indexterm>
|
---|
348 | </sect2>
|
---|
349 |
|
---|
350 | <sect2 role="content">
|
---|
351 | <title>Contents</title>
|
---|
352 |
|
---|
353 | <segmentedlist>
|
---|
354 | <segtitle>Installed Programs</segtitle>
|
---|
355 | <segtitle>Installed Libraries</segtitle>
|
---|
356 | <segtitle>Installed Directories</segtitle>
|
---|
357 |
|
---|
358 | <seglistitem>
|
---|
359 | <seg>
|
---|
360 | qtwebengine_convert_dict and
|
---|
361 | QtWebEngineProcess (both in $QT6DIR/libexec)
|
---|
362 | </seg>
|
---|
363 | <seg>
|
---|
364 | libQt6Pdf.so,
|
---|
365 | libQt6PdfQuick.so,
|
---|
366 | libQt6PdfWidgets.so,
|
---|
367 | libQt6WebEngineCore.so,
|
---|
368 | libQt6WebEngineiQuick.so,
|
---|
369 | libQt6WebEngineQuickDelegatesQml.so, and
|
---|
370 | libQt6WebEngineWidgets.so
|
---|
371 | </seg>
|
---|
372 | <seg>
|
---|
373 | $QT6DIR/include/QtPdf,
|
---|
374 | $QT6DIR/include/QtPdfQuick,
|
---|
375 | $QT6DIR/include/QtPdfWidgets,
|
---|
376 | $QT6DIR/include/QtWebEngineCore,
|
---|
377 | $QT6DIR/include/QtWebEngineQuick,
|
---|
378 | $QT6DIR/include/QtWebEngineWidgets,
|
---|
379 | $QT6DIR/qml/QtWebEngine, and
|
---|
380 | $QT6DIR/translations/qtwebengine_locales
|
---|
381 | </seg>
|
---|
382 | </seglistitem>
|
---|
383 | </segmentedlist>
|
---|
384 |
|
---|
385 | <variablelist>
|
---|
386 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
387 | <?dbfo list-presentation="list"?>
|
---|
388 | <?dbhtml list-presentation="table"?>
|
---|
389 |
|
---|
390 | <varlistentry id="qtwebengine_convert_dict">
|
---|
391 | <term><command>qtwebengine_convert_dict</command></term>
|
---|
392 | <listitem>
|
---|
393 | <para>
|
---|
394 | converts hunspell dictionaries (<literal>.dic</literal>) to chromium
|
---|
395 | format (<literal>.bdic</literal>)
|
---|
396 | </para>
|
---|
397 | <indexterm zone="qtwebengine qtwebengine_convert_dict">
|
---|
398 | <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
|
---|
399 | </indexterm>
|
---|
400 | </listitem>
|
---|
401 | </varlistentry>
|
---|
402 |
|
---|
403 | <varlistentry id="QtWebEngineProcess">
|
---|
404 | <term><command>QtWebEngineProcess</command></term>
|
---|
405 | <listitem>
|
---|
406 | <para>
|
---|
407 | is a libexec program which runs a zygote process (one that listens
|
---|
408 | for spawn requests from a master process and will fork itself in
|
---|
409 | response)
|
---|
410 | </para>
|
---|
411 | <indexterm zone="qtwebengine QtWebEngineProcess">
|
---|
412 | <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
|
---|
413 | </indexterm>
|
---|
414 | </listitem>
|
---|
415 | </varlistentry>
|
---|
416 | <!--
|
---|
417 | <varlistentry id="libQtWebEngine-lib">
|
---|
418 | <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
|
---|
419 | <listitem>
|
---|
420 | <para>
|
---|
421 | provides QML types for rendering web content within a QML application
|
---|
422 | </para>
|
---|
423 | <indexterm zone="qtwebengine libQtWebEngine-lib">
|
---|
424 | <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
|
---|
425 | </indexterm>
|
---|
426 | </listitem>
|
---|
427 | </varlistentry>
|
---|
428 |
|
---|
429 | <varlistentry id="libQtWebEngineCore">
|
---|
430 | <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
|
---|
431 | <listitem>
|
---|
432 | <para>
|
---|
433 | provides public API shared by both QtWebEngine and QtWebEngineWidgets
|
---|
434 | </para>
|
---|
435 | <indexterm zone="qtwebengine libQtWebEngineCore">
|
---|
436 | <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
|
---|
437 | </indexterm>
|
---|
438 | </listitem>
|
---|
439 | </varlistentry>
|
---|
440 |
|
---|
441 | <varlistentry id="libQtWebEngineWidgets">
|
---|
442 | <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
|
---|
443 | <listitem>
|
---|
444 | <para>
|
---|
445 | provides a web browser engine as well as C++ classes to render and
|
---|
446 | interact with web content
|
---|
447 | </para>
|
---|
448 | <indexterm zone="qtwebengine libQtWebEngineWidgets">
|
---|
449 | <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
|
---|
450 | </indexterm>
|
---|
451 | </listitem>
|
---|
452 | </varlistentry>
|
---|
453 | -->
|
---|
454 | </variablelist>
|
---|
455 | </sect2>
|
---|
456 |
|
---|
457 | </sect1>
|
---|