source: x/lib/qtwebengine.xml@ bc5b7af

elogind
Last change on this file since bc5b7af was bc5b7af, checked in by DJ Lucas <dj@…>, 3 years ago

Merge to HEAD 21122.

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

  • Property mode set to 100644
File size: 13.4 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.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 "516c70f4f5ef8f4d0462425735f4ff47">
11 <!ENTITY qtwebengine-size "238 MB">
12 <!ENTITY qtwebengine-buildsize "3.3 GB (134 MB installed)">
13 <!ENTITY qtwebengine-time "60 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 &lfs83_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 += |&amp;$$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>mv -v ${QT5DIR}/lib/libQtWebEngineCore.so{,.old}</userinput></screen>
171
172<!-- Not needed for 5.12.1
173 <para>
174 If you are building on a 32-bit i686 system, GCC changed the alignof
175 operator to optimize the ABI. Unfortunately, this makes the alignof()
176 operator return an incorrect number (4 instead of 8). Apply a patch to
177 fix this:
178 </para>
179
180<screen><userinput>patch -Np1 -i ../qtwebengine-&qtwebengine-version;-i686_alignof_fix-1.patch</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<!--
209 <para>
210 If you built the HTML documentation, install it with:
211 </para>
212
213<screen role="root"><userinput>make install_docs</userinput></screen>
214-->
215 <para>
216 Remove references to the build directory from installed library
217 dependency (prl) files by running the following
218 commands as the <systemitem class="username">root</systemitem> user:
219 </para>
220
221<screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
222 -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
223 </sect2>
224
225 <sect2 role="commands">
226 <title>Command Explanations</title>
227
228 <para>
229 <command>qmake</command>: This will build the included copy of
230 <application>ninja</application> if it is not already installed
231 and use it to configure the build.
232 </para>
233
234 <para>
235 <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
236 passed to qmake they must come after '--' which must follow '..' that points
237 to the main directory. The options here cause it to use system ffmpeg and
238 system icu. If built as part of full Qt5, the system icu is automatically
239 used (only) by Qt5Core if it is available, but unless this option is used
240 webengine will always use its shipped copy of icu, adding time and space
241 to the build.
242 </para>
243
244 <para>
245 <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
246 recognize the NINJAJOBS environment variable, this command will run system
247 ninja with the specified number of jobs (i.e. 4). Among the reasons why
248 you might want to do this are: building on a subset of CPUs, either to
249 measure the build time for that number of processors or to run other
250 CPU-intensive tasks on other cores, or to improve the build speed on a
251 less-well endowed 4-core machine. On a machine with a powerful CPU and
252 plenty of RAM, running N+2 jobs (the ninja default for 4+ cores) for the
253 large working sets of the C++ compiles in this package is typically only
254 marginally faster than running N jobs at a time. But for a machine with
255 less memory it can be much slower.
256 </para>
257
258 </sect2>
259
260 <sect2 role="configuration">
261 <title>Configuring QtWebEngine</title>
262
263 <sect3 id="qtwebengine-config">
264 <title>Configuration Information</title>
265
266 <para>
267 If you are upgrading from an older minor version of this
268 application, for some webpages to load you may need to
269 clear the <emphasis>browser</emphasis> caches, e.g. for
270 <application>falkon</application> they will be found in
271 <filename class="directory">~/.cache/falkon/</filename>.
272 You will need to do this if the browser starts to render
273 the page and then changes to a blank tab with a message
274 that something went wrong, and a button to Retry. Even
275 after removing the old caches, you may need to retry a
276 few times for each affected tab.
277 </para>
278
279 </sect3>
280
281 </sect2>
282
283
284 <sect2 role="content">
285 <title>Contents</title>
286
287 <segmentedlist>
288 <segtitle>Installed Programs</segtitle>
289 <segtitle>Installed Libraries</segtitle>
290 <segtitle>Installed Directories</segtitle>
291
292 <seglistitem>
293 <seg>
294 qtwebengine_convert_dict and
295 QtWebEngineProcess
296 </seg>
297 <seg>
298 libQt5WebEngineCore.so,
299 libQt5WebEngine.so, and
300 libQt5WebEngineWidgets.so
301 </seg>
302 <seg>
303 $QT5PREFIX/doc/qtwebengine,
304 $QT5PREFIX/includeQtWebEngine,
305 $QT5PREFIX/include/QtWebEngineCore, and
306 $QT5PREFIX/include/QtWebEngineWidgets
307 </seg>
308 </seglistitem>
309 </segmentedlist>
310
311 <variablelist>
312 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
313 <?dbfo list-presentation="list"?>
314 <?dbhtml list-presentation="table"?>
315
316 <varlistentry id="qtwebengine_convert_dict">
317 <term><command>qtwebengine_convert_dict</command></term>
318 <listitem>
319 <para>
320 converts hunspell dictionaries (<literal>.dic</literal>) to chromium
321 format (<literal>.bdic</literal>)
322 </para>
323 <indexterm zone="qtwebengine qtwebengine_convert_dict">
324 <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="QtWebEngineProcess">
330 <term><command>QtWebEngineProcess</command></term>
331 <listitem>
332 <para>
333 is a libexec program which runs a zygote process (one that listens
334 for spawn requests from a master process and will fork itself in
335 response).
336 </para>
337 <indexterm zone="qtwebengine QtWebEngineProcess">
338 <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="libQtWebEngine-lib">
344 <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
345 <listitem>
346 <para>
347 provides QML types for rendering web content within a QML application.
348 </para>
349 <indexterm zone="qtwebengine libQtWebEngine-lib">
350 <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="libQtWebEngineCore">
356 <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
357 <listitem>
358 <para>
359 provides public API shared by both QtWebEngine and QtWebEngineWidgets.
360 </para>
361 <indexterm zone="qtwebengine libQtWebEngineCore">
362 <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="libQtWebEngineWidgets">
368 <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
369 <listitem>
370 <para>
371 provides a web browser engine as well as C++ classes to render and
372 interact with web content.
373 </para>
374 <indexterm zone="qtwebengine libQtWebEngineWidgets">
375 <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 </variablelist>
381 </sect2>
382</sect1>
Note: See TracBrowser for help on using the repository browser.