source: x/lib/qtwebengine.xml@ 0cf3733

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 9.1 gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 0cf3733 was 0cf3733, checked in by Pierre Labastie <pieere@…>, 5 years ago

Add the python2 module for MarkupSafe so that Jinja2 can use it,
and recommend Jinja2 for QtWebEngine, since it is used in the build,
otherwise a shipped version is used

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

  • Property mode set to 100644
File size: 13.9 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.13">
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 "0f6a3e3d9c1a17be769fca94d4a8f7cb">
11 <!ENTITY qtwebengine-size "245 MB">
12 <!ENTITY qtwebengine-buildsize "3.5 GB (135 MB installed)">
13 <!ENTITY qtwebengine-time "61 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 <para>
171 If an older version of the package's main library has been installed,
172 when the package is built separately it will link to that in preference
173 to its own not-yet-installed version, and fail because of missing symbols.
174 Prevent that by, as the <systemitem class="username">root</systemitem>
175 user, moving the symlink out of the way.:
176 </para>
177
178<screen role="root"><userinput>if [ -e ${QT5DIR}/lib/libQt5WebEngineCore.so ]; then
179 mv -v ${QT5DIR}/lib/libQt5WebEngineCore.so{,.old}
180fi</userinput></screen>
181
182 <para>
183 Install <application>qtwebengine</application> by running the following
184 commands:
185 </para>
186
187<screen><userinput>mkdir build &amp;&amp;
188cd build &amp;&amp;
189
190qmake .. -- -system-ffmpeg -webengine-icu &amp;&amp;
191make</userinput></screen>
192<!--
193 <para>
194 if you wish to build the HTML documentation, issue:
195 </para>
196
197<screen><userinput>make docs</userinput></screen>
198-->
199 <para>
200 This package does not come with a test suite.
201 </para>
202
203 <para>
204 Now, as the <systemitem class="username">root</systemitem> user:
205 </para>
206
207<screen role="root"><userinput>make install</userinput></screen>
208 <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
209 instead of DESTDIR= -->
210<!--
211 <para>
212 If you built the HTML documentation, install it with:
213 </para>
214
215<screen role="root"><userinput>make install_docs</userinput></screen>
216-->
217 <para>
218 Remove references to the build directory from installed library
219 dependency (prl) files by running the following
220 commands as the <systemitem class="username">root</systemitem> user:
221 </para>
222
223<screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
224 -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
225 </sect2>
226
227 <sect2 role="commands">
228 <title>Command Explanations</title>
229
230 <para>
231 <command>qmake</command>: This will build the included copy of
232 <application>ninja</application> if it is not already installed
233 and use it to configure the build.
234 </para>
235
236 <para>
237 <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
238 passed to qmake they must come after '--' which must follow '..' that points
239 to the main directory. The options here cause it to use system ffmpeg and
240 system icu. If built as part of full Qt5, the system icu is automatically
241 used (only) by Qt5Core if it is available, but unless this option is used
242 webengine will always use its shipped copy of icu, adding time and space
243 to the build.
244 </para>
245
246 <!--
247 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
248 href="../../xincludes/SIOCGSTAMP.xml"/>
249 -->
250
251 <para>
252 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
253 recognize the NINJAJOBS environment variable, this command will run system
254 ninja with the specified number of jobs (i.e. 4).
255 There are several reasons why you might want to do this:</para>
256
257 <itemizedlist>
258 <listitem>
259 <para> Building on a subset of CPUs allows measuring the build time
260 for that number of processors or to run other CPU-intensive tasks on
261 other cores.</para>
262 </listitem>
263 <listitem>
264 <para>Improving the build speed on a less-well endowed 4-core
265 machine. On a machine with a powerful CPU and plenty of RAM, running
266 N+2 jobs (the ninja default for 4+ cores) for the large working sets
267 of the C++ compiles in this package is typically only marginally
268 faster than running N jobs at a time. But for a machine with less
269 memory it can be much slower.</para>
270 </listitem>
271 <listitem>
272 <para>Reducing the number of cores being used on long running, CPU
273 intensive packages may alleviate heat problems.</para>
274 </listitem>
275 </itemizedlist>
276
277 </sect2>
278
279 <sect2 role="configuration">
280 <title>Configuring QtWebEngine</title>
281
282 <sect3 id="qtwebengine-config">
283 <title>Configuration Information</title>
284
285 <para>
286 If you are upgrading from an older minor version of this
287 application, for some webpages to load you may need to
288 clear the <emphasis>browser</emphasis> caches, e.g. for
289 <application>falkon</application> they will be found in
290 <filename class="directory">~/.cache/falkon/</filename>.
291 You will need to do this if the browser starts to render
292 the page and then changes to a blank tab with a message
293 that something went wrong, and a button to Retry. Even
294 after removing the old caches, you may need to retry a
295 few times for each affected tab.
296 </para>
297
298 </sect3>
299
300 </sect2>
301
302
303 <sect2 role="content">
304 <title>Contents</title>
305
306 <segmentedlist>
307 <segtitle>Installed Programs</segtitle>
308 <segtitle>Installed Libraries</segtitle>
309 <segtitle>Installed Directories</segtitle>
310
311 <seglistitem>
312 <seg>
313 qtwebengine_convert_dict and
314 QtWebEngineProcess
315 </seg>
316 <seg>
317 libQt5WebEngineCore.so,
318 libQt5WebEngine.so, and
319 libQt5WebEngineWidgets.so
320 </seg>
321 <seg>
322 $QT5PREFIX/includeQtWebEngine,
323 $QT5PREFIX/include/QtWebEngineCore, and
324 $QT5PREFIX/include/QtWebEngineWidgets
325 </seg>
326 </seglistitem>
327 </segmentedlist>
328
329 <variablelist>
330 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
331 <?dbfo list-presentation="list"?>
332 <?dbhtml list-presentation="table"?>
333
334 <varlistentry id="qtwebengine_convert_dict">
335 <term><command>qtwebengine_convert_dict</command></term>
336 <listitem>
337 <para>
338 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
339 format (<literal>.bdic</literal>)
340 </para>
341 <indexterm zone="qtwebengine qtwebengine_convert_dict">
342 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="QtWebEngineProcess">
348 <term><command>QtWebEngineProcess</command></term>
349 <listitem>
350 <para>
351 is a libexec program which runs a zygote process (one that listens
352 for spawn requests from a master process and will fork itself in
353 response).
354 </para>
355 <indexterm zone="qtwebengine QtWebEngineProcess">
356 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="libQtWebEngine-lib">
362 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
363 <listitem>
364 <para>
365 provides QML types for rendering web content within a QML application.
366 </para>
367 <indexterm zone="qtwebengine libQtWebEngine-lib">
368 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="libQtWebEngineCore">
374 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
375 <listitem>
376 <para>
377 provides public API shared by both QtWebEngine and QtWebEngineWidgets.
378 </para>
379 <indexterm zone="qtwebengine libQtWebEngineCore">
380 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="libQtWebEngineWidgets">
386 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
387 <listitem>
388 <para>
389 provides a web browser engine as well as C++ classes to render and
390 interact with web content.
391 </para>
392 <indexterm zone="qtwebengine libQtWebEngineWidgets">
393 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 </variablelist>
399 </sect2>
400</sect1>
Note: See TracBrowser for help on using the repository browser.