[ceb3dc7] | 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 |
|
---|
[55a55f1] | 7 | <!ENTITY qtwebengine-major "5.12">
|
---|
[57e07f4] | 8 | <!ENTITY qtwebengine-download-http "https://download.qt.io/archive/qt/&qtwebengine-major;/&qtwebengine-version;/submodules/qtwebengine-everywhere-src-&qtwebengine-version;.tar.xz">
|
---|
[ceb3dc7] | 9 | <!ENTITY qtwebengine-download-ftp " ">
|
---|
[55a55f1] | 10 | <!ENTITY qtwebengine-md5sum "53d74f6ed0c188ee106381d9cba99e94">
|
---|
| 11 | <!ENTITY qtwebengine-size "241 MB">
|
---|
| 12 | <!ENTITY qtwebengine-buildsize "3.3 GB (134 MB installed)">
|
---|
| 13 | <!ENTITY qtwebengine-time "36 SBU (using 4 cores)">
|
---|
[ceb3dc7] | 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
|
---|
[55a55f1] | 35 | <application>chromium</application>'s web capabilities into Qt. It
|
---|
[a9c0e8d] | 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
|
---|
[ceb3dc7] | 39 | <application>chromium</application> developers.
|
---|
| 40 | </para>
|
---|
| 41 |
|
---|
[66966b2] | 42 | &lfs83_checked;
|
---|
[088e7e06] | 43 |
|
---|
[55a55f1] | 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 <xref
|
---|
| 58 | linkend="qt5"/> and the static library is not available, that build will
|
---|
| 59 | either complete without installing webengine, or else fail during the
|
---|
| 60 | install (both variants have been observed).
|
---|
| 61 | </para>
|
---|
| 62 | </note>
|
---|
[ceb3dc7] | 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">qtwebengine Dependencies</bridgehead>
|
---|
| 99 |
|
---|
| 100 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 101 | <!-- the qmake output tends to be misleading. 'khr' is from Mesa -->
|
---|
| 102 | <para role="required">
|
---|
| 103 | <xref linkend="nss"/>,
|
---|
[55a55f1] | 104 | <xref linkend="python2"/>, and
|
---|
[ceb3dc7] | 105 | <xref linkend='qt5'/>
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 109 | <note>
|
---|
| 110 | <para>
|
---|
| 111 | If these packages are not installed, the build process will compile and
|
---|
| 112 | install its own (perhaps older) version, with the side effect of
|
---|
| 113 | increasing build and installed disk space and build time.
|
---|
| 114 | </para>
|
---|
| 115 | </note>
|
---|
| 116 |
|
---|
| 117 | <para role="recommended">
|
---|
[55a55f1] | 118 | either <xref linkend="alsa-lib"/> or
|
---|
| 119 | <xref linkend="pulseaudio"/> (or both),
|
---|
| 120 | <xref linkend="ffmpeg"/>,
|
---|
| 121 | <xref linkend="icu"/>,
|
---|
[ceb3dc7] | 122 | <xref linkend="libwebp"/>,
|
---|
[55a55f1] | 123 | <xref linkend="libxslt"/>, and
|
---|
[f5932da] | 124 | <xref linkend="opus"/>
|
---|
[ceb3dc7] | 125 | </para>
|
---|
| 126 |
|
---|
| 127 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 128 | <para role="optional">
|
---|
| 129 | <xref linkend="libevent"/>,
|
---|
| 130 | <ulink url="https://github.com/open-source-parsers/jsoncpp/releases">jsoncpp</ulink>,
|
---|
| 131 | <ulink url="https://github.com/cisco/libsrtp/releases">libsrtp</ulink>,
|
---|
| 132 | <ulink url="http://google.github.io/snappy/">snappy</ulink>
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <para condition="html" role="usernotes">
|
---|
| 136 | User Notes: <ulink url="&blfs-wiki;/qtwebengine"/>
|
---|
| 137 | </para>
|
---|
| 138 | </sect2>
|
---|
| 139 |
|
---|
| 140 | <sect2 role="installation">
|
---|
| 141 | <title>Installation of qtwebengine</title>
|
---|
| 142 |
|
---|
| 143 | <para>
|
---|
| 144 | Install <application>qtwebengine</application> by running the following
|
---|
| 145 | commands:
|
---|
| 146 | </para>
|
---|
| 147 |
|
---|
[55a55f1] | 148 | <para>
|
---|
| 149 | First, ensure that the local headers are available when not building as
|
---|
| 150 | part of the complete <xref linkend="qt5"/>:
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | <screen><userinput>find -type f -name "*.pr[io]" |
|
---|
| 154 | xargs sed -i -e 's|INCLUDEPATH += |&$$QTWEBENGINE_ROOT/include |'</userinput></screen>
|
---|
| 155 |
|
---|
| 156 | <para>
|
---|
| 157 | If an older version of the package's main library has been installed,
|
---|
| 158 | when the package is built separately it will link to that in preference
|
---|
| 159 | to its own not-yet-installed version, and fail because of missing symbols.
|
---|
| 160 | Prevent that by, as the <systemitem class="username">root</systemitem>
|
---|
| 161 | user, moving the symlink out of the way.:
|
---|
| 162 | </para>
|
---|
| 163 |
|
---|
| 164 | <screen role="root"><userinput>mv -v ${QT5DIR}/lib/libQtWebEngineCore.so{,.old}</userinput></screen>
|
---|
| 165 |
|
---|
[640f4c21] | 166 | <screen><userinput>mkdir build &&
|
---|
| 167 | cd build &&
|
---|
[ceb3dc7] | 168 |
|
---|
[2234c90] | 169 | qmake .. -- -system-ffmpeg -webengine-icu &&
|
---|
[640f4c21] | 170 | make</userinput></screen>
|
---|
| 171 | <!--
|
---|
[ceb3dc7] | 172 | <para>
|
---|
| 173 | if you wish to build the HTML documentation, issue:
|
---|
| 174 | </para>
|
---|
| 175 |
|
---|
| 176 | <screen><userinput>make docs</userinput></screen>
|
---|
[640f4c21] | 177 | -->
|
---|
[ceb3dc7] | 178 | <para>
|
---|
| 179 | This package does not come with a test suite.
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
| 182 | <para>
|
---|
| 183 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 184 | </para>
|
---|
| 185 |
|
---|
[640f4c21] | 186 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 187 | <!--
|
---|
[ceb3dc7] | 188 | <para>
|
---|
| 189 | If you built the HTML documentation, install it with:
|
---|
| 190 | </para>
|
---|
| 191 |
|
---|
| 192 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
[640f4c21] | 193 | -->
|
---|
[ceb3dc7] | 194 | <para>
|
---|
| 195 | Remove references to the build directory from installed library
|
---|
| 196 | dependency (prl) files by running the following
|
---|
| 197 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
| 198 | </para>
|
---|
| 199 |
|
---|
[dff94d4] | 200 | <screen role="root"><userinput>find $QT5DIR/ -name \*.prl \
|
---|
[ceb3dc7] | 201 | -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;</userinput></screen>
|
---|
| 202 | </sect2>
|
---|
| 203 |
|
---|
| 204 | <sect2 role="commands">
|
---|
| 205 | <title>Command Explanations</title>
|
---|
| 206 |
|
---|
| 207 | <para>
|
---|
[640f4c21] | 208 | <command>qmake</command>: This will build the included copy of
|
---|
| 209 | <application>ninja</application> if it is not already installed
|
---|
[088e7e06] | 210 | and use it to configure the build.
|
---|
| 211 | </para>
|
---|
| 212 |
|
---|
[55a55f1] | 213 | <para>
|
---|
[2234c90] | 214 | <command>-- -system-ffmpeg -webengine-icu</command>: If any options are
|
---|
| 215 | passed to qmake ithey must come after '--' which must follow '..' that points
|
---|
[55a55f1] | 216 | to the main directory. The options here cause it to use system ffmpeg and
|
---|
| 217 | system icu. If built as part of full Qt5, the system icu is automatically
|
---|
| 218 | used (only) by Qt5Core if it is available, but unless this option is used
|
---|
| 219 | webengine will always use its shipped copy of icu, adding time and space
|
---|
| 220 | to the build.
|
---|
| 221 | </para>
|
---|
| 222 |
|
---|
[088e7e06] | 223 | <para>
|
---|
| 224 | <option>NINJAJOBS=4 make</option>: If you patched system ninja in LFS to
|
---|
| 225 | recognize the NINJAJOBS environment variable, this command will run system
|
---|
| 226 | ninja with the specified number of jobs (i.e. 4). Among the reasons why
|
---|
| 227 | you might want to do this are: building on a subset of CPUs, either to
|
---|
| 228 | measure the build time for that number of processors or to run other
|
---|
| 229 | CPU-intensive tasks on other cores, or to improve the build speed on a
|
---|
| 230 | less-well endowed 4-core machine. On a machine with a powerful CPU and
|
---|
| 231 | plenty of RAM, running N+2 jobs (the ninja default for 4+ cores) for the
|
---|
| 232 | large working sets of the C++ compiles in this package is typically only
|
---|
[496ef5e] | 233 | marginally faster than running N jobs at a time. But for a machine with
|
---|
| 234 | less memory it can be much slower.
|
---|
[ceb3dc7] | 235 | </para>
|
---|
| 236 |
|
---|
| 237 | </sect2>
|
---|
| 238 |
|
---|
[55a55f1] | 239 | <sect2 role="configuration">
|
---|
| 240 | <title>Configuring QtWebEngine</title>
|
---|
| 241 |
|
---|
| 242 | <sect3 id="qtwebengine-config">
|
---|
| 243 | <title>Configuration Information</title>
|
---|
| 244 |
|
---|
| 245 | <para>
|
---|
| 246 | If you are upgrading from an older minor version of this
|
---|
| 247 | application, for some webpages to load you may need to
|
---|
| 248 | clear the <emphasis>browser</emphasis> caches, e.g. for
|
---|
| 249 | <application>falkon</application> they will be found in
|
---|
| 250 | <filename class="directory">~/.cache/falkon/</filename>.
|
---|
| 251 | You will need to do this if the browser starts to render
|
---|
| 252 | the page and then changes to a blank tab with a message
|
---|
| 253 | that something went wrong, and a button to Retry. Even
|
---|
| 254 | after removing the old caches, you may need to retry a
|
---|
| 255 | few times for each affected tab.
|
---|
| 256 | </para>
|
---|
| 257 |
|
---|
| 258 | </sect3>
|
---|
| 259 |
|
---|
| 260 | </sect2>
|
---|
| 261 |
|
---|
| 262 |
|
---|
[ceb3dc7] | 263 | <sect2 role="content">
|
---|
| 264 | <title>Contents</title>
|
---|
| 265 |
|
---|
| 266 | <segmentedlist>
|
---|
| 267 | <segtitle>Installed Programs</segtitle>
|
---|
| 268 | <segtitle>Installed Libraries</segtitle>
|
---|
| 269 | <segtitle>Installed Directories</segtitle>
|
---|
| 270 |
|
---|
| 271 | <seglistitem>
|
---|
| 272 | <seg>
|
---|
[640f4c21] | 273 | qtwebengine_convert_dict and
|
---|
| 274 | QtWebEngineProcess
|
---|
[ceb3dc7] | 275 | </seg>
|
---|
| 276 | <seg>
|
---|
[640f4c21] | 277 | libQt5WebEngineCore.so,
|
---|
| 278 | libQt5WebEngine.so, and
|
---|
| 279 | libQt5WebEngineWidgets.so
|
---|
[ceb3dc7] | 280 | </seg>
|
---|
| 281 | <seg>
|
---|
| 282 | $QT5PREFIX/doc/qtwebengine,
|
---|
| 283 | $QT5PREFIX/includeQtWebEngine,
|
---|
[640f4c21] | 284 | $QT5PREFIX/include/QtWebEngineCore, and
|
---|
[ceb3dc7] | 285 | $QT5PREFIX/include/QtWebEngineWidgets
|
---|
| 286 | </seg>
|
---|
| 287 | </seglistitem>
|
---|
| 288 | </segmentedlist>
|
---|
| 289 |
|
---|
| 290 | <variablelist>
|
---|
| 291 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 292 | <?dbfo list-presentation="list"?>
|
---|
| 293 | <?dbhtml list-presentation="table"?>
|
---|
| 294 |
|
---|
| 295 | <varlistentry id="qtwebengine_convert_dict">
|
---|
| 296 | <term><command>qtwebengine_convert_dict</command></term>
|
---|
| 297 | <listitem>
|
---|
| 298 | <para>
|
---|
| 299 | converts hunspell dictionaries (<literal>.dic</literal>) to chromium
|
---|
| 300 | format (<literal>.bdic</literal>)
|
---|
| 301 | </para>
|
---|
| 302 | <indexterm zone="qtwebengine qtwebengine_convert_dict">
|
---|
| 303 | <primary sortas="b-qtwebengine_convert_dict">qtwebengine_convert_dict</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
| 307 |
|
---|
| 308 | <varlistentry id="QtWebEngineProcess">
|
---|
| 309 | <term><command>QtWebEngineProcess</command></term>
|
---|
| 310 | <listitem>
|
---|
| 311 | <para>
|
---|
| 312 | is a libexec program which runs a zygote process (one that listens
|
---|
| 313 | for spawn requests from a master process and will fork itself in
|
---|
| 314 | response).
|
---|
| 315 | </para>
|
---|
| 316 | <indexterm zone="qtwebengine QtWebEngineProcess">
|
---|
| 317 | <primary sortas="b-QtWebEngineProcess">QtWebEngineProcess</primary>
|
---|
| 318 | </indexterm>
|
---|
| 319 | </listitem>
|
---|
| 320 | </varlistentry>
|
---|
| 321 |
|
---|
| 322 | <varlistentry id="libQtWebEngine-lib">
|
---|
| 323 | <term><filename class="libraryfile">libQtWebEngine.so</filename></term>
|
---|
| 324 | <listitem>
|
---|
| 325 | <para>
|
---|
| 326 | provides QML types for rendering web content within a QML application.
|
---|
| 327 | </para>
|
---|
| 328 | <indexterm zone="qtwebengine libQtWebEngine-lib">
|
---|
| 329 | <primary sortas="c-libQtWebEngine">libQtWebEngine.so</primary>
|
---|
| 330 | </indexterm>
|
---|
| 331 | </listitem>
|
---|
| 332 | </varlistentry>
|
---|
| 333 |
|
---|
| 334 | <varlistentry id="libQtWebEngineCore">
|
---|
| 335 | <term><filename class="libraryfile">libQtWebEngineCore.so</filename></term>
|
---|
| 336 | <listitem>
|
---|
| 337 | <para>
|
---|
| 338 | provides public API shared by both QtWebEngine and QtWebEngineWidgets.
|
---|
| 339 | </para>
|
---|
| 340 | <indexterm zone="qtwebengine libQtWebEngineCore">
|
---|
| 341 | <primary sortas="c-libQtWebEngineCore">libQtWebEngineCore.so</primary>
|
---|
| 342 | </indexterm>
|
---|
| 343 | </listitem>
|
---|
| 344 | </varlistentry>
|
---|
| 345 |
|
---|
| 346 | <varlistentry id="libQtWebEngineWidgets">
|
---|
| 347 | <term><filename class="libraryfile">libQtWebEngineWidgets.so</filename></term>
|
---|
| 348 | <listitem>
|
---|
| 349 | <para>
|
---|
| 350 | provides a web browser engine as well as C++ classes to render and
|
---|
| 351 | interact with web content.
|
---|
| 352 | </para>
|
---|
| 353 | <indexterm zone="qtwebengine libQtWebEngineWidgets">
|
---|
| 354 | <primary sortas="c-libQtWebEngineWidgets">libQtWebEngineWidgets.so</primary>
|
---|
| 355 | </indexterm>
|
---|
| 356 | </listitem>
|
---|
| 357 | </varlistentry>
|
---|
| 358 |
|
---|
| 359 | </variablelist>
|
---|
| 360 | </sect2>
|
---|
| 361 | </sect1>
|
---|