source: x/lib/qtwebengine.xml@ 49a01c11

trunk
Last change on this file since 49a01c11 was c28dcdf1, checked in by Rahul Chandra <rahul@…>, 5 weeks ago

QtWebEngine Typos

I removed QtWebEngine from the python 3.11 page as well as
I don't think it needs python 3.11 to build anymore.
  • 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="nodejs"/>,
156 <xref linkend="nss"/>,
157 <xref linkend="pciutils"/>, and
158 <xref linkend='qt6'/>
159 </para>
160
161 <bridgehead renderas="sect4">Recommended</bridgehead>
162 <note>
163 <para>
164 If these packages are not installed, the build process will compile and
165 install its own (perhaps older) version, with the side effect of
166 increasing build and installed disk space and build time.
167 </para>
168 </note>
169
170 <para role="recommended">
171 either <xref linkend="alsa-lib"/> or
172 <xref linkend="pulseaudio"/> (or both),
173 <xref linkend="ffmpeg"/>,
174 <xref linkend="icu"/>,
175 <xref linkend="libwebp"/>,
176 <xref linkend="libxslt"/>, and
177 <xref linkend="opus"/>
178 </para>
179
180 <bridgehead renderas="sect4">Optional</bridgehead>
181 <para role="optional">
182 <xref linkend="libevent"/>,
183 <xref linkend="mitkrb"/>,
184 <xref linkend="pipewire"/>,
185 <xref linkend="poppler"/>,
186 <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
187 <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
188 <ulink url="https://google.github.io/snappy/">snappy</ulink>
189 </para>
190
191 </sect2>
192
193 <sect2 role="installation">
194 <title>Installation of qtwebengine</title>
195 <para>
196 Install <application>qtwebengine</application> by running the following
197 commands:
198 </para>
199
200<screen><userinput>mkdir build &amp;&amp;
201cd build &amp;&amp;
202
203cmake -D CMAKE_MESSAGE_LOG_LEVEL=STATUS \
204 -D QT_FEATURE_webengine_system_ffmpeg=ON \
205 -D QT_FEATURE_webengine_system_icu=ON \
206 -D QT_FEATURE_webengine_system_libevent=ON \
207 -D QT_FEATURE_webengine_proprietary_codecs=ON \
208 -D QT_FEATURE_webengine_webrtc_pipewire=ON \
209 -D QT_BUILD_EXAMPLES_BY_DEFAULT=OFF \
210 -G Ninja .. &amp;&amp;
211
212ninja</userinput></screen>
213
214 <para>
215 This package does not come with a test suite.
216 </para>
217
218 <para>
219 Now, as the <systemitem class="username">root</systemitem> user:
220 </para>
221
222<screen role="root"><userinput>ninja install</userinput></screen>
223
224 <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
225 instead of DESTDIR= Not sure this is valid any more with version 6.6.2 -->
226 </sect2>
227
228 <sect2 role="commands">
229 <title>Command Explanations</title>
230
231 <para>
232 <parameter>CMAKE_MESSAGE_LOG_LEVEL=STATUS</parameter>: Output
233 interesting messages that project users might be interested in.
234 Ideally these should be concise, no more than a single line,
235 but still informative.
236 </para>
237
238 <para>
239 <parameter>QT_FEATURE_webengine_system_*</parameter>: Specify what
240 external packages the system should use.
241 </para>
242
243 <para>
244 <parameter>QT_BUILD_EXAMPLES_BY_DEFAULT=OFF</parameter>: Do not build
245 examples by default.
246 </para>
247
248 <para>
249 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
250 recognize the NINJAJOBS environment variable, this command will run system
251 ninja with the specified number of jobs (i.e. 4).
252 There are several reasons why you might want to use options like this this:
253 </para>
254
255 <itemizedlist>
256 <listitem>
257 <para>
258 Building on a subset of CPUs allows measuring the build time
259 for a smaller number of processors, and/or running other
260 CPU-intensive tasks at the same time. For an editor on a machine
261 with a lot of CPUs, trying to measure the build time for a 4-CPU
262 machine, <option>NINJAJOBS=4 make</option> will give a reasonable
263 approximation (there is a short period where N+2 python and node
264 jobs run).
265 </para>
266 </listitem>
267 <listitem>
268 <para>
269 On a machine with only 4 CPUs online, the default of scheduling
270 N+2 jobs for qtwebengine is slower by between 3% and 7%, probably
271 because of the size of the C++ files and their many includes and
272 templates. Therefore, if in doubt set NINJAJOBS to the number of CPUs.
273 </para>
274 </listitem>
275 <listitem>
276 <para>
277 Reducing the number of cores being used on long running, CPU
278 intensive packages may alleviate heat problems.
279 </para>
280 </listitem>
281 <listitem>
282 <para>
283 Reducing the number of cores will prevent potential out-of-memory
284 problems on systems that do not have enough memory (or swap)
285 when all cores are active. A suggested approach is to limit
286 the number of cores to about one core for each 1.5 GB of
287 combined RAM and swap space.
288 </para>
289 </listitem>
290 </itemizedlist>
291
292 </sect2>
293
294 <sect2 role="configuration">
295 <title>Configuring QtWebEngine</title>
296
297 <sect3 id="qtwebengine-config">
298 <title>Configuration Information</title>
299
300 <para>
301 If you are upgrading from an older minor version of this
302 application, for some webpages to load you may need to
303 clear the <emphasis>browser</emphasis> caches, e.g. for
304 <application>falkon</application> they will be found in
305 <filename class="directory">~/.cache/falkon/</filename>.
306 You will need to do this if the browser starts to render
307 the page and then changes to a blank tab with a message
308 that something went wrong, and a button to Retry. Even
309 after removing the old caches, you may need to retry a
310 few times for each affected tab.
311 </para>
312
313 <para>
314 If a browser using this package fails to run and when run
315 from a term it reports 'Trace/breakpoint trap' that is
316 probably a kernel configuration issue - there is no need
317 to rebuild QtWebEngine, see the next section, recompile
318 the kernel and reboot to the new kernel.
319 </para>
320
321 </sect3>
322
323 </sect2>
324
325 <sect2 role="kernel" id="qtwebengine-kernel">
326 <title>Kernel Configuration</title>
327
328 <para>
329 This package does not require any of the optional kernel namespace items,
330 but if User namespace is enabled <phrase revision="systemd">(as happens
331 in some unit files, for hardening)</phrase> PID namespace must also be
332 enabled. In that case enable the following options in the kernel
333 configuration and recompile the kernel if necessary:
334 </para>
335
336 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
337 href="qtwebengine-kernel.xml"/>
338
339 <indexterm zone="qtwebengine qtwebengine-kernel">
340 <primary sortas="d-qtwebengine">qtwebengine</primary>
341 </indexterm>
342 </sect2>
343
344 <sect2 role="content">
345 <title>Contents</title>
346
347 <segmentedlist>
348 <segtitle>Installed Programs</segtitle>
349 <segtitle>Installed Libraries</segtitle>
350 <segtitle>Installed Directories</segtitle>
351
352 <seglistitem>
353 <seg>
354 qtwebengine_convert_dict and
355 QtWebEngineProcess (both in $QT6DIR/libexec)
356 </seg>
357 <seg>
358 libQt6Pdf.so,
359 libQt6PdfQuick.so,
360 libQt6PdfWidgets.so,
361 libQt6WebEngineCore.so,
362 libQt6WebEngineiQuick.so,
363 libQt6WebEngineQuickDelegatesQml.so, and
364 libQt6WebEngineWidgets.so
365 </seg>
366 <seg>
367 $QT6DIR/include/QtPdf,
368 $QT6DIR/include/QtPdfQuick,
369 $QT6DIR/include/QtPdfWidgets,
370 $QT6DIR/include/QtWebEngineCore,
371 $QT6DIR/include/QtWebEngineQuick,
372 $QT6DIR/include/QtWebEngineWidgets,
373 $QT6DIR/qml/QtWebEngine, and
374 $QT6DIR/translations/qtwebengine_locales
375 </seg>
376 </seglistitem>
377 </segmentedlist>
378
379 <variablelist>
380 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
381 <?dbfo list-presentation="list"?>
382 <?dbhtml list-presentation="table"?>
383
384 <varlistentry id="qtwebengine_convert_dict">
385 <term><command>qtwebengine_convert_dict</command></term>
386 <listitem>
387 <para>
388 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
389 format (<literal>.bdic</literal>)
390 </para>
391 <indexterm zone="qtwebengine qtwebengine_convert_dict">
392 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="QtWebEngineProcess">
398 <term><command>QtWebEngineProcess</command></term>
399 <listitem>
400 <para>
401 is a libexec program which runs a zygote process (one that listens
402 for spawn requests from a master process and will fork itself in
403 response)
404 </para>
405 <indexterm zone="qtwebengine QtWebEngineProcess">
406 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410<!--
411 <varlistentry id="libQtWebEngine-lib">
412 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
413 <listitem>
414 <para>
415 provides QML types for rendering web content within a QML application
416 </para>
417 <indexterm zone="qtwebengine libQtWebEngine-lib">
418 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="libQtWebEngineCore">
424 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
425 <listitem>
426 <para>
427 provides public API shared by both QtWebEngine and QtWebEngineWidgets
428 </para>
429 <indexterm zone="qtwebengine libQtWebEngineCore">
430 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="libQtWebEngineWidgets">
436 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
437 <listitem>
438 <para>
439 provides a web browser engine as well as C++ classes to render and
440 interact with web content
441 </para>
442 <indexterm zone="qtwebengine libQtWebEngineWidgets">
443 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447-->
448 </variablelist>
449 </sect2>
450
451</sect1>
Note: See TracBrowser for help on using the repository browser.