source: x/lib/qtwebengine.xml@ c716497

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since c716497 was c716497, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Remove the Linux 5.2 change from qtwebengine since the fix to glibc in LFS now covers it

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