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.12">
|
---|
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 "a5182f10645103b54a35f8611fd13506">
|
---|
11 | <!ENTITY qtwebengine-size "238 MB">
|
---|
12 | <!ENTITY qtwebengine-buildsize "3.2 GB (133 MB installed)">
|
---|
13 | <!ENTITY qtwebengine-time "51 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 | <!-- The patch is not needed anymore for 5.12.1
|
---|
99 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
100 | <itemizedlist spacing="compact">
|
---|
101 | <listitem>
|
---|
102 | <para>
|
---|
103 | Required patch (if building on i686):
|
---|
104 | <ulink url="&patch-root;/qtwebengine-&qtwebengine-version;-i686_alignof_fix-1.patch"/>
|
---|
105 | </para>
|
---|
106 | </listitem>
|
---|
107 | </itemizedlist>
|
---|
108 | -->
|
---|
109 | <bridgehead renderas="sect3">qtwebengine Dependencies</bridgehead>
|
---|
110 |
|
---|
111 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
112 | <!-- the qmake output tends to be misleading. 'khr' is from Mesa -->
|
---|
113 | <para role="required">
|
---|
114 | <xref linkend="nss"/>,
|
---|
115 | <xref linkend="python2"/>, and
|
---|
116 | <xref linkend='qt5'/>
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
120 | <note>
|
---|
121 | <para>
|
---|
122 | If these packages are not installed, the build process will compile and
|
---|
123 | install its own (perhaps older) version, with the side effect of
|
---|
124 | increasing build and installed disk space and build time.
|
---|
125 | </para>
|
---|
126 | </note>
|
---|
127 |
|
---|
128 | <para role="recommended">
|
---|
129 | either <xref linkend="alsa-lib"/> or
|
---|
130 | <xref linkend="pulseaudio"/> (or both),
|
---|
131 | <xref linkend="ffmpeg"/>,
|
---|
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 | <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 += |&$$QTWEBENGINE_ROOT/include |'</userinput></screen>
|
---|
161 |
|
---|
162 | <para>
|
---|
163 | If an older version of the package's main library has been installed,
|
---|
164 | when the package is built separately it will link to that in preference
|
---|
165 | to its own not-yet-installed version, and fail because of missing symbols.
|
---|
166 | Prevent that by, as the <systemitem class="username">root</systemitem>
|
---|
167 | user, moving the symlink out of the way.:
|
---|
168 | </para>
|
---|
169 |
|
---|
170 | <screen role="root"><userinput>if [ -e ${QT5DIR}/lib/libQtWebEngineCore.so ]; then
|
---|
171 | mv -v ${QT5DIR}/lib/libQtWebEngineCore.so{,.old}
|
---|
172 | fi</userinput></screen>
|
---|
173 |
|
---|
174 | <!-- Not needed for 5.12.1
|
---|
175 | <para>
|
---|
176 | If you are building on a 32-bit i686 system, GCC changed the alignof
|
---|
177 | operator to optimize the ABI. Unfortunately, this makes the alignof()
|
---|
178 | operator return an incorrect number (4 instead of 8). Apply a patch to
|
---|
179 | fix this:
|
---|
180 | </para>
|
---|
181 |
|
---|
182 | <screen><userinput>patch -Np1 -i ../qtwebengine-&qtwebengine-version;-i686_alignof_fix-1.patch</userinput></screen>
|
---|
183 | -->
|
---|
184 | <para>
|
---|
185 | Install <application>qtwebengine</application> by running the following
|
---|
186 | commands:
|
---|
187 | </para>
|
---|
188 |
|
---|
189 | <screen><userinput>mkdir build &&
|
---|
190 | cd build &&
|
---|
191 |
|
---|
192 | qmake .. -- -system-ffmpeg -webengine-icu &&
|
---|
193 | make</userinput></screen>
|
---|
194 | <!--
|
---|
195 | <para>
|
---|
196 | if you wish to build the HTML documentation, issue:
|
---|
197 | </para>
|
---|
198 |
|
---|
199 | <screen><userinput>make docs</userinput></screen>
|
---|
200 | -->
|
---|
201 | <para>
|
---|
202 | This package does not come with a test suite.
|
---|
203 | </para>
|
---|
204 |
|
---|
205 | <para>
|
---|
206 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
207 | </para>
|
---|
208 |
|
---|
209 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
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 | <para>
|
---|
247 | <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
|
---|
248 | recognize the NINJAJOBS environment variable, this command will run system
|
---|
249 | ninja with the specified number of jobs (i.e. 4).
|
---|
250 | There are several reasons why you might want to do this:</para>
|
---|
251 |
|
---|
252 | <itemizedlist>
|
---|
253 | <listitem>
|
---|
254 | <para> Building on a subset of CPUs allows measuring the build time
|
---|
255 | for that number of processors or to run other CPU-intensive tasks on
|
---|
256 | other cores.</para>
|
---|
257 | </listitem>
|
---|
258 | <listitem>
|
---|
259 | <para>Improving the build speed on a less-well endowed 4-core
|
---|
260 | machine. On a machine with a powerful CPU and plenty of RAM, running
|
---|
261 | N+2 jobs (the ninja default for 4+ cores) for the large working sets
|
---|
262 | of the C++ compiles in this package is typically only marginally
|
---|
263 | faster than running N jobs at a time. But for a machine with less
|
---|
264 | memory it can be much slower.</para>
|
---|
265 | </listitem>
|
---|
266 | <listitem>
|
---|
267 | <para>Reducing the number of cores being used on long running, CPU
|
---|
268 | intensive packages may alleviate heat problems.</para>
|
---|
269 | </listitem>
|
---|
270 | </itemizedlist>
|
---|
271 |
|
---|
272 | </sect2>
|
---|
273 |
|
---|
274 | <sect2 role="configuration">
|
---|
275 | <title>Configuring QtWebEngine</title>
|
---|
276 |
|
---|
277 | <sect3 id="qtwebengine-config">
|
---|
278 | <title>Configuration Information</title>
|
---|
279 |
|
---|
280 | <para>
|
---|
281 | If you are upgrading from an older minor version of this
|
---|
282 | application, for some webpages to load you may need to
|
---|
283 | clear the <emphasis>browser</emphasis> caches, e.g. for
|
---|
284 | <application>falkon</application> they will be found in
|
---|
285 | <filename class="directory">~/.cache/falkon/</filename>.
|
---|
286 | You will need to do this if the browser starts to render
|
---|
287 | the page and then changes to a blank tab with a message
|
---|
288 | that something went wrong, and a button to Retry. Even
|
---|
289 | after removing the old caches, you may need to retry a
|
---|
290 | few times for each affected tab.
|
---|
291 | </para>
|
---|
292 |
|
---|
293 | </sect3>
|
---|
294 |
|
---|
295 | </sect2>
|
---|
296 |
|
---|
297 |
|
---|
298 | <sect2 role="content">
|
---|
299 | <title>Contents</title>
|
---|
300 |
|
---|
301 | <segmentedlist>
|
---|
302 | <segtitle>Installed Programs</segtitle>
|
---|
303 | <segtitle>Installed Libraries</segtitle>
|
---|
304 | <segtitle>Installed Directories</segtitle>
|
---|
305 |
|
---|
306 | <seglistitem>
|
---|
307 | <seg>
|
---|
308 | qtwebengine_convert_dict and
|
---|
309 | QtWebEngineProcess
|
---|
310 | </seg>
|
---|
311 | <seg>
|
---|
312 | libQt5WebEngineCore.so,
|
---|
313 | libQt5WebEngine.so, and
|
---|
314 | libQt5WebEngineWidgets.so
|
---|
315 | </seg>
|
---|
316 | <seg>
|
---|
317 | $QT5PREFIX/doc/qtwebengine,
|
---|
318 | $QT5PREFIX/includeQtWebEngine,
|
---|
319 | $QT5PREFIX/include/QtWebEngineCore, and
|
---|
320 | $QT5PREFIX/include/QtWebEngineWidgets
|
---|
321 | </seg>
|
---|
322 | </seglistitem>
|
---|
323 | </segmentedlist>
|
---|
324 |
|
---|
325 | <variablelist>
|
---|
326 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
327 | <?dbfo list-presentation="list"?>
|
---|
328 | <?dbhtml list-presentation="table"?>
|
---|
329 |
|
---|
330 | <varlistentry id="qtwebengine_convert_dict">
|
---|
331 | <term><command>qtwebengine_convert_dict</command></term>
|
---|
332 | <listitem>
|
---|
333 | <para>
|
---|
334 | converts hunspell dictionaries (<literal>.dic</literal>) to chromium
|
---|
335 | format (<literal>.bdic</literal>)
|
---|
336 | </para>
|
---|
337 | <indexterm zone="qtwebengine qtwebengine_convert_dict">
|
---|
338 | <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
|
---|
339 | </indexterm>
|
---|
340 | </listitem>
|
---|
341 | </varlistentry>
|
---|
342 |
|
---|
343 | <varlistentry id="QtWebEngineProcess">
|
---|
344 | <term><command>QtWebEngineProcess</command></term>
|
---|
345 | <listitem>
|
---|
346 | <para>
|
---|
347 | is a libexec program which runs a zygote process (one that listens
|
---|
348 | for spawn requests from a master process and will fork itself in
|
---|
349 | response).
|
---|
350 | </para>
|
---|
351 | <indexterm zone="qtwebengine QtWebEngineProcess">
|
---|
352 | <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
|
---|
353 | </indexterm>
|
---|
354 | </listitem>
|
---|
355 | </varlistentry>
|
---|
356 |
|
---|
357 | <varlistentry id="libQtWebEngine-lib">
|
---|
358 | <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
|
---|
359 | <listitem>
|
---|
360 | <para>
|
---|
361 | provides QML types for rendering web content within a QML application.
|
---|
362 | </para>
|
---|
363 | <indexterm zone="qtwebengine libQtWebEngine-lib">
|
---|
364 | <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
|
---|
365 | </indexterm>
|
---|
366 | </listitem>
|
---|
367 | </varlistentry>
|
---|
368 |
|
---|
369 | <varlistentry id="libQtWebEngineCore">
|
---|
370 | <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
|
---|
371 | <listitem>
|
---|
372 | <para>
|
---|
373 | provides public API shared by both QtWebEngine and QtWebEngineWidgets.
|
---|
374 | </para>
|
---|
375 | <indexterm zone="qtwebengine libQtWebEngineCore">
|
---|
376 | <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
|
---|
377 | </indexterm>
|
---|
378 | </listitem>
|
---|
379 | </varlistentry>
|
---|
380 |
|
---|
381 | <varlistentry id="libQtWebEngineWidgets">
|
---|
382 | <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
|
---|
383 | <listitem>
|
---|
384 | <para>
|
---|
385 | provides a web browser engine as well as C++ classes to render and
|
---|
386 | interact with web content.
|
---|
387 | </para>
|
---|
388 | <indexterm zone="qtwebengine libQtWebEngineWidgets">
|
---|
389 | <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
|
---|
390 | </indexterm>
|
---|
391 | </listitem>
|
---|
392 | </varlistentry>
|
---|
393 |
|
---|
394 | </variablelist>
|
---|
395 | </sect2>
|
---|
396 | </sect1>
|
---|