source: x/lib/qtwebengine.xml@ e1b67062

trunk
Last change on this file since e1b67062 was a3e69b9b, checked in by Bruce Dubbs <bdubbs@…>, 5 weeks ago

Added perl modules html5lib and webencodings

These packages are needed in suport of qtwebengine.

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