source: x/lib/qtwebengine.xml@ fa4e429

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 fa4e429 was fa4e429, checked in by Pierre Labastie <pieere@…>, 3 years ago

Remove some qtwebengine instructions left from previous versions, and useless
now

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

  • Property mode set to 100644
File size: 14.8 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, allow the pulseaudio library to be linked at build time, instead
173 of run time. This also prevents an issue with newer pulseaudio:
174 </para>
175
176<screen><userinput>sed -e '/link_pulseaudio/s/false/true/' \
177 -i src/3rdparty/chromium/media/media_options.gni</userinput></screen>
178
179 <para>
180 Finally, fix a change in the build system which allows its developers to
181 pass e.g. -j20 to make (for quick tests of some areas) but breaks the
182 build with LFS's use of the NINJAJOBS environment variable:
183 </para>
184
185<!-- editors: See thread at
186http://lists.linuxfromscratch.org/pipermail/blfs-dev/2019-December/036996.html
187et.seq, particularly 037002.html which shows the commit near the end. -->
188
189<screen><userinput>sed -i 's/NINJAJOBS/NINJA_JOBS/' src/core/gn_run.pro</userinput></screen>
190
191 <para>
192 If an older version of the package's main library has been installed,
193 when the package is built separately it will link to that in preference
194 to its own not-yet-installed version, and fail because of missing symbols.
195 Prevent that by, as the <systemitem class="username">root</systemitem>
196 user, moving the symlink out of the way:
197 </para>
198
199<screen role="root"><userinput>if [ -e ${QT5DIR}/lib/libQt5WebEngineCore.so ]; then
200 mv -v ${QT5DIR}/lib/libQt5WebEngineCore.so{,.old}
201fi</userinput></screen>
202
203 <para>
204 Install <application>qtwebengine</application> by running the following
205 commands:
206 </para>
207
208<screen><userinput>mkdir build &amp;&amp;
209cd build &amp;&amp;
210
211qmake .. -- -system-ffmpeg -webengine-icu &amp;&amp;
212make</userinput></screen>
213<!--
214 <para>
215 if you wish to build the HTML documentation, issue:
216 </para>
217
218<screen><userinput>make docs</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>make install</userinput></screen>
229 <!-- EDITORS NOTE: If you are updating this package, use INSTALL_ROOT=
230 instead of DESTDIR= -->
231<!--
232 <para>
233 If you built the HTML documentation, install it with:
234 </para>
235
236<screen role="root"><userinput>make install_docs</userinput></screen>
237-->
238 <para>
239 Remove references to the build directory from installed library
240 dependency (prl) files by running the following
241 commands as the <systemitem class="username">root</systemitem> user:
242 </para>
243
244<screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
245 -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
246 </sect2>
247
248 <sect2 role="commands">
249 <title>Command Explanations</title>
250
251 <para>
252 <command>qmake</command>: This will build the included copy of
253 <application>ninja</application> if it is not already installed
254 and use it to configure the build.
255 </para>
256
257 <para>
258 <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
259 passed to qmake they must come after '--' which must follow '..' that points
260 to the main directory. The options here cause it to use system ffmpeg and
261 system icu. If built as part of full Qt5, the system icu is automatically
262 used (only) by Qt5Core if it is available, but unless this option is used
263 webengine will always use its shipped copy of icu, adding time and space
264 to the build.
265 </para>
266
267 <!--
268 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
269 href="../../xincludes/SIOCGSTAMP.xml"/>
270 -->
271
272 <para>
273 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
274 recognize the NINJAJOBS environment variable, this command will run system
275 ninja with the specified number of jobs (i.e. 4).
276 There are several reasons why you might want to do this:</para>
277
278 <itemizedlist>
279 <listitem>
280 <para> Building on a subset of CPUs allows measuring the build time
281 for that number of processors or to run other CPU-intensive tasks on
282 other cores.</para>
283 </listitem>
284 <listitem>
285 <para>Improving the build speed on a less-well endowed 4-core
286 machine. On a machine with a powerful CPU and plenty of RAM, running
287 N+2 jobs (the ninja default for 4+ cores) for the large working sets
288 of the C++ compiles in this package is typically only marginally
289 faster than running N jobs at a time. But for a machine with less
290 memory it can be much slower.</para>
291 </listitem>
292 <listitem>
293 <para>Reducing the number of cores being used on long running, CPU
294 intensive packages may alleviate heat problems.</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 </sect3>
320
321 </sect2>
322
323
324 <sect2 role="content">
325 <title>Contents</title>
326
327 <segmentedlist>
328 <segtitle>Installed Programs</segtitle>
329 <segtitle>Installed Libraries</segtitle>
330 <segtitle>Installed Directories</segtitle>
331
332 <seglistitem>
333 <seg>
334 qtwebengine_convert_dict and
335 QtWebEngineProcess (in $QT5DIR/libexec)
336 </seg>
337 <seg>
338 libQt5WebEngineCore.so,
339 libQt5WebEngine.so, and
340 libQt5WebEngineWidgets.so
341 </seg>
342 <seg>
343 $QT5DIR/include/QtWebEngine,
344 $QT5DIR/include/QtWebEngineCore,
345 $QT5DIR/include/QtWebEngineWidgets,
346 $QT5DIR/qml/QtWebEngine, and
347 $QT5DIR/translations/qtwebengine_locales
348 </seg>
349 </seglistitem>
350 </segmentedlist>
351
352 <variablelist>
353 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
354 <?dbfo list-presentation="list"?>
355 <?dbhtml list-presentation="table"?>
356
357 <varlistentry id="qtwebengine_convert_dict">
358 <term><command>qtwebengine_convert_dict</command></term>
359 <listitem>
360 <para>
361 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
362 format (<literal>.bdic</literal>)
363 </para>
364 <indexterm zone="qtwebengine qtwebengine_convert_dict">
365 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="QtWebEngineProcess">
371 <term><command>QtWebEngineProcess</command></term>
372 <listitem>
373 <para>
374 is a libexec program which runs a zygote process (one that listens
375 for spawn requests from a master process and will fork itself in
376 response).
377 </para>
378 <indexterm zone="qtwebengine QtWebEngineProcess">
379 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="libQtWebEngine-lib">
385 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
386 <listitem>
387 <para>
388 provides QML types for rendering web content within a QML application.
389 </para>
390 <indexterm zone="qtwebengine libQtWebEngine-lib">
391 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="libQtWebEngineCore">
397 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
398 <listitem>
399 <para>
400 provides public API shared by both QtWebEngine and QtWebEngineWidgets.
401 </para>
402 <indexterm zone="qtwebengine libQtWebEngineCore">
403 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="libQtWebEngineWidgets">
409 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
410 <listitem>
411 <para>
412 provides a web browser engine as well as C++ classes to render and
413 interact with web content.
414 </para>
415 <indexterm zone="qtwebengine libQtWebEngineWidgets">
416 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 </variablelist>
422 </sect2>
423</sect1>
Note: See TracBrowser for help on using the repository browser.