glfs/kde/kf5/kf5-frameworks.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 <!ENTITY % general-entities SYSTEM "../../general.ent">
 %general-entities;

  <!-- kf5-download-http is defined on packages.ent
  <!ENTITY kf5-download-http "&kf5-download-http;"> -->
  <!ENTITY kf5-download-ftp  " ">
  <!ENTITY kf5-md5sum        "See Below">
  <!ENTITY kf5-size          "272 MB">
  <!ENTITY kf5-buildsize     "1.4 GB (245 MB installed)">
  <!ENTITY kf5-time          "15 SBU (using parallelism=4)">
]>

<sect1 id="kf5-frameworks" xreflabel="KDE Frameworks-&kf5-version;">
  <?dbhtml filename="frameworks5.html"?>

  <sect1info>
     <date>$Date$</date>
  </sect1info>

  <title>Building KDE Frameworks 5 (KF5)</title>

  <indexterm zone="kf5-frameworks">
     <primary sortas="a-kde-frameworks">KDE Frameworks</primary>
  </indexterm>

  <para>
    KDE Frameworks 5 is a collection of libraries based on top of Qt5 and
    QML derived from the monolithic KDE 4 libraries. They can be used
    independent of the KDE Display Environment (Plasma 5).
  </para>

  &lfs111_checked;

  <para>
    The instructions below build all of the KDE Frameworks packages in one
    step by using a bash script.
  </para>

  <bridgehead renderas="sect3">Package Information</bridgehead>
  <itemizedlist spacing="compact">
    <listitem>
      <para>
        Download (HTTP): <ulink url="&kf5-download-http;"/>
      </para>
    </listitem>
    <listitem>
      <para>
        Download (FTP): <ulink url="&kf5-download-ftp;"/>
      </para>
    </listitem>
    <listitem>
      <para>
        Download MD5 sum: &kf5-md5sum;
      </para>
    </listitem>
    <listitem>
      <para>
        Download size: &kf5-size;
      </para>
    </listitem>
    <listitem>
      <para>
        Estimated disk space required: &kf5-buildsize;
      </para>
    </listitem>
    <listitem>
      <para>
        Estimated build time: &kf5-time;
      </para>
    </listitem>
  </itemizedlist>

  <bridgehead renderas="sect3">KF5 Dependencies</bridgehead>

  <bridgehead renderas="sect4">Required</bridgehead>
  <para role="required">
    <xref linkend="boost"/>,
    <xref linkend="extra-cmake-modules"/>,
    <xref linkend="DocBook"/>,
    <xref linkend="docbook-xsl"/>,
    <xref linkend="giflib"/>,
    <xref linkend="libepoxy"/>,
    <xref linkend="libgcrypt"/>,
    <xref linkend="libical"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="libpng"/>,
    <xref linkend="libxslt"/>,
    <xref linkend="lmdb"/>,
    <xref linkend="qrencode"/>,
    <xref linkend="phonon"/>,
    <xref linkend="plasma-wayland-protocols"/>,
    <xref linkend="shared-mime-info"/>,
    <xref linkend="perl-uri"/>, and
    <xref linkend="wget"/> (required to download the packages)
  </para>

  <bridgehead renderas="sect4">Recommended</bridgehead>
  <para role="recommended">
    <xref linkend="aspell"/> (Dictionary backend for Sonnet),
    <xref linkend="avahi"/> (DNS-SD backend for KDNSSD),
    <xref linkend="libdbusmenu-qt"/> (built with qt5),
    <xref linkend="NetworkManager"/> (needed to build NetworkManager-Qt), and
    <xref linkend="polkit-qt"/> (Authentication backend for KAuth)
  </para>

  <para role="recommended">
    Furthermore, the instructions below assume that the environment has been
    set up as described in <xref linkend="kf5-intro"/>.
  </para>

  <bridgehead renderas="sect4">Optional</bridgehead>
  <para role="optional">
    <xref linkend="bluez"/> (needed to build Bluez-Qt),
    <xref linkend="ModemManager"/> (needed to build ModemManager-Qt),
    <ulink url="http://libdmtx.sourceforge.net/">Datamatrix</ulink> (deemed
      recommended for Prison by upstream)
  </para>

  <bridgehead renderas="sect4">Runtime dependency for FrameworkIntegration</bridgehead>
  <para role="optional">
    <xref role="runtime" linkend="oxygen-fonts"/> and
    <xref role="runtime" linkend="noto-fonts"/>
  </para>
  <!-- kapidox is commented out for now, see ticket #16805. Revisit when
  our mind is made
  <bridgehead renderas="sect4">Additional recommended dependencies for kapidox</bridgehead>
  <para role="recommended">
    <xref role="runtime" linkend="doxygen"/> (Run time)<phrase revision="sysv">,
    <xref linkend="Jinja2"/>, and
    <xref linkend="PyYAML"/> (if those python modules are not present at build
    time, they will be downloaded)</phrase>
    <phrase revision="systemd"> and
    <xref linkend="PyYAML"/> (if this python module is not present at build
    time, it will be downloaded)</phrase>
  </para>

  <bridgehead renderas="sect4">Other python modules needed by kapidox</bridgehead>
  <para role="optional">
    <ulink url="https://pypi.org/simple/requests/">requests</ulink>,
    <ulink url="https://pypi.org/simple/doxyqml/">doxyqml</ulink>,
    <ulink url="https://pypi.org/simple/doxypypy/">doxypypy</ulink>,
    <ulink url="https://pypi.org/simple/urllib3/">urllib3</ulink>,
    <ulink url="https://pypi.org/simple/idna/">idna</ulink>,
    <ulink url="https://pypi.org/simple/charset-normalizer/">charset-normalizer</ulink>, and
    <ulink url="https://pypi.org/simple/certifi/">certifi</ulink> (all will be
    automatically installed at build time if not present on the system)
  </para>
  -->
  <bridgehead renderas="sect4">Additional image formats support in KImageFormats</bridgehead>
  <para role="optional">
    <xref linkend="jasper"/> and
    <ulink url="http://www.openexr.com/">OpenEXR</ulink>
  </para>

  <bridgehead renderas="sect4">Optional dependencies for KIO</bridgehead>
  <para role="optional">
    <xref linkend="mitkrb"/>
  </para>

  <bridgehead renderas="sect4">Optional dependencies for Solid</bridgehead>
  <para role="optional">
    <xref linkend="udisks2"/>,
    <xref linkend="upower"/> and
    <ulink role="runtime" url="http://www.freedesktop.org/software/media-player-info/">media-player-info</ulink> (runtime)
  </para>

  <bridgehead renderas="sect4">Optional dependency for KWallet</bridgehead>
  <para role="optional">
    <xref linkend="gpgme"/>, built with C++ bindings (which is the default).
  </para>

  <bridgehead renderas="sect4">Optional dictionary backends for Sonnet</bridgehead>
  <para role="optional">
    <ulink url="http://hspell.ivrix.org.il/">Hspell</ulink> and
    <ulink url="http://hunspell.sourceforge.net/">Hunspell</ulink>
  </para>

  <para condition="html" role="usernotes">User Notes:
  <ulink url="&blfs-wiki;/kf5"/></para>

  <sect2>
    <title>Downloading KDE Frameworks</title>

    <para>
      The easiest way to get the KDE Frameworks packages is to use a single
      <command>wget</command> to fetch them all at once:
    </para>

<screen><userinput>url=https://download.kde.org/stable/frameworks/&kf5-short-version;/
wget -r -nH -nd -A '*.xz' -np $url</userinput>
<literal>
The options used here are:
  -r            recurse through child directories
  -nH           disable generation of host-prefixed directories
  -nd           do not create a hierarchy of directories
  -A '*.xz'     just get the *.xz files
  -np           don't get parent directories</literal></screen>

   </sect2>

  <sect2>
    <title>Setting Package Order</title>

    <para>
      The order of building files is important due to internal dependencies.
      Create the list of files in the proper order as follows:
    </para>

<!-- commenting out kapidox for now, see ticket #16805. This package
     needs special instructions because it is a pure python package. -->
<screen><userinput>cat &gt; frameworks-&kf5-version;.md5 &lt;&lt; "EOF"
<literal>4c58b14c3e9b566efa1192d4ecd2af79  attica-5.94.0.tar.xz
#87284231fba89d63a644fd5580a93419  extra-cmake-modules-5.94.0.tar.xz
#05881681bb54a656df941760ec95f78f  kapidox-5.94.0.tar.xz
7755930b43e6d1c2ffd84d3a0900837c  karchive-5.94.0.tar.xz
5e369a4776d905113ffd3ff4253ec242  kcodecs-5.94.0.tar.xz
ef377ebb6a0a186f0b0c1d866e9cd9e0  kconfig-5.94.0.tar.xz
08307d77429c08cace165ee332774150  kcoreaddons-5.94.0.tar.xz
ec62f262f1e18f18f98583e2c2a9eef0  kdbusaddons-5.94.0.tar.xz
6e904e169b64308f26a849e97b57a229  kdnssd-5.94.0.tar.xz
b2c6301308c0d14e175ed7247a20a2f5  kguiaddons-5.94.0.tar.xz
a5ed561a992e8c153ba8ee9e928df775  ki18n-5.94.0.tar.xz
a20e40478fd1d97dfb1de841c618ddbb  kidletime-5.94.0.tar.xz
5d8a593d887dd87ec275ecd60463c23e  kimageformats-5.94.0.tar.xz
c70d3292fd64cf0601031a77b952da16  kitemmodels-5.94.0.tar.xz
598084088d4aa8774ed45fd90f27b889  kitemviews-5.94.0.tar.xz
a405d0efed821d49046701e23df3a15a  kplotting-5.94.0.tar.xz
28ec585eb7b021d9fe36c34a04e15e45  kwidgetsaddons-5.94.0.tar.xz
dc4600c342cf19a59f77a0a3e6f15f9a  kwindowsystem-5.94.0.tar.xz
13b415dae8fecc7bc13fd74da8dcbd5c  networkmanager-qt-5.94.0.tar.xz
f01586b53ec25461a79e9b041384ccf6  solid-5.94.0.tar.xz
4d9bb4004e793c74090b09c517a73ed3  sonnet-5.94.0.tar.xz
e0587825e0f9a9900907ebc5bdec4fc7  threadweaver-5.94.0.tar.xz
63298692e6643c2f9c46f5e896092249  kauth-5.94.0.tar.xz
df116b33cd4701417804995181043e17  kcompletion-5.94.0.tar.xz
b15403397a15cdd19cc9c37cc641a390  kcrash-5.94.0.tar.xz
89150622d44cbe16d0866630679ed344  kdoctools-5.94.0.tar.xz
8c9e66d27034ab827a7bff258c26ac40  kpty-5.94.0.tar.xz
e4614a7ff9b50b45f0d331569b1f037c  kunitconversion-5.94.0.tar.xz
99b651617d4aa11de8da3a29fca4f293  kconfigwidgets-5.94.0.tar.xz
0b503bfe8fa34c67d7cd05c3e4569deb  kservice-5.94.0.tar.xz
8962279f6b830f6facb2b4774fe3bbd5  kglobalaccel-5.94.0.tar.xz
f21bde21930493488e580b7ab2fb9a68  kpackage-5.94.0.tar.xz
0740b92bcdf9a693337a44d8d60010a8  kdesu-5.94.0.tar.xz
4074814f4ef40b9c4ef98730d04eacc3  kemoticons-5.94.0.tar.xz
39d57f459d465ee36257afa00d14c4af  kiconthemes-5.94.0.tar.xz
4efc13aa9b4c25e0c8ecdccbded0258b  kjobwidgets-5.94.0.tar.xz
b1eed570adcf176e26732e11d443b45f  knotifications-5.94.0.tar.xz
02196b04420b82dea5a8cfb1afe4c3ed  ktextwidgets-5.94.0.tar.xz
9e3262d243d0647fa449637bb6721257  kxmlgui-5.94.0.tar.xz
fdf2b3aa23143a61245d5c9c71b1e10a  kbookmarks-5.94.0.tar.xz
33dfaa62d9a29c728d5517cb470f4cab  kwallet-5.94.0.tar.xz
df17b4d7749752ea870f41ee939a6de2  kded-5.94.0.tar.xz
b173ed937a1031bbe3fcb9b00cde8ddf  kio-5.94.0.tar.xz
e1545546a5dffb1a204ee52ce35f262a  kdeclarative-5.94.0.tar.xz
1db143e7ae245d53c83310532f22c42c  kcmutils-5.94.0.tar.xz
a7dd929fe16bee46a7a6405496e07c1a  kirigami2-5.94.0.tar.xz
0b5af5f1b6a01fbfc2f9409080b1ed6d  syndication-5.94.0.tar.xz
910e635386cdbc7fb001a26188f2ad2f  knewstuff-5.94.0.tar.xz
e1234f34020f69e96029159b985a90fe  frameworkintegration-5.94.0.tar.xz
22d387e61144829658ee37e39dc63cd3  kinit-5.94.0.tar.xz
1eda63d543969f2e92a4bcd3431042d7  kparts-5.94.0.tar.xz
21e2b0a1a22a23b10396c8eed8c31b00  kactivities-5.94.0.tar.xz
#c67ab93795b50e39b1e31628da1ca011  kdewebkit-5.94.0.tar.xz
1848474b94ea30081d287870f9cba116  syntax-highlighting-5.94.0.tar.xz
0b2d6b28c7d543c1d32ad9726e29e40f  ktexteditor-5.94.0.tar.xz
4fbb3293df1edb2605ce928dcb562d97  kdesignerplugin-5.94.0.tar.xz
71e3be9e7c55af746b96d6ac72434019  kwayland-5.94.0.tar.xz
a3e74066c093105e4bb46f6feeecf16c  plasma-framework-5.94.0.tar.xz
#37ee3c5a952c19c827bb183ae0c30af1  modemmanager-qt-5.94.0.tar.xz
add7886e4c40a1f391bdb590130bc7ab  kpeople-5.94.0.tar.xz
f4b6e612931d90c89719a91710c1ca5c  kxmlrpcclient-5.94.0.tar.xz
f26170bc0c78b72cdeb0908df7524181  bluez-qt-5.94.0.tar.xz
3c1187cff306f87dce08100996a93b96  kfilemetadata-5.94.0.tar.xz
a453a4ab37073aafeb6e5a5c487230b9  baloo-5.94.0.tar.xz
#30d8ecac16f36e4b9fd1794a39460c42  breeze-icons-5.94.0.tar.xz
#0101721db51fdce9dd6e3e3b6de46f2a  oxygen-icons5-5.94.0.tar.xz
ff23ccf6ade8f2a7709b36846748758e  kactivities-stats-5.94.0.tar.xz
69f5c374d56ff468b8cd5d0cf6b3e223  krunner-5.94.0.tar.xz
60c71e3c275b97caacd7568987a4fab4  prison-5.94.0.tar.xz
5a24bcad8364bc54f08eeef64920d2c5  qqc2-desktop-style-5.94.0.tar.xz
10cd152091f2c14d7dcb888cd69aa902  kjs-5.94.0.tar.xz
caa2c3e5dcc94924877e5f1d2430b5a6  kdelibs4support-5.94.0.tar.xz
3afa34590fcc12338c17118859a604b3  khtml-5.94.0.tar.xz
7b2dd5afb48757ea1ec22f22a9fe880e  kjsembed-5.94.0.tar.xz
42434eaee534d1d82cd152368fd695a8  kmediaplayer-5.94.0.tar.xz
0ded971b6d9aa1fdc27d721c022fd6e4  kross-5.94.0.tar.xz
7f5fe39fa4d9714aeffa75d381a8d63a  kholidays-5.94.0.tar.xz
62928a8400931c074e4f924899e0ee3b  purpose-5.94.0.tar.xz
cef3c9347f6feb52ccb5bdf3d32d3572  kcalendarcore-5.94.0.tar.xz
e871157fef871e5b65c728b7bbc52c47  kcontacts-5.94.0.tar.xz
774aab02052060e0935b53a80b6aee2c  kquickcharts-5.94.0.tar.xz
d5eb244dabef2a80fef3344410fe1d89  knotifyconfig-5.94.0.tar.xz
67d0ce7a0c7bc64c5711440817585fce  kdav-5.94.0.tar.xz</literal>
EOF</userinput></screen>

  <para>
    In the above list, notice that some files have been commented out with
    a hash (#) character. The extra-cmake-modules entry has been commented out
    because it was built earlier in the <xref linkend="kde-prereq"/>. The icon
    packages are covered separately at <xref linkend="breeze-icons"/> and <xref
    linkend="oxygen-icons5"/>.  The modemmanager-qt package may be built if its
    optional dependency has been installed. The
    kdewebkit may be built if the external package
    <ulink url="https://download.qt.io/community_releases/5.9/5.9.0-final/">
    QtWebkit</ulink> has been built. The kapidox package is a pure python
    package and cannot be built with the instructions below.
  </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of KDE Frameworks</title>

    &as_root;

    <caution>

      <para>
        If installing in <filename class="directory">/opt</filename> and there
        is an existing /opt/kf5 either as a regular directory or a symbolic
        link, it should be reinitialized (as <systemitem class="username">
        root</systemitem>):
      </para>

      <screen role="root" revision="sysv"><userinput>mv -v /opt/kf5 /opt/kf5.old                         &amp;&amp;
install -v -dm755           $KF5_PREFIX/{etc,share} &amp;&amp;
ln -sfv /etc/dbus-1         $KF5_PREFIX/etc         &amp;&amp;
ln -sfv /usr/share/dbus-1   $KF5_PREFIX/share       &amp;&amp;
ln -sfv /usr/share/polkit-1 $KF5_PREFIX/share</userinput></screen>

      <screen role="root" revision="systemd"><userinput>mv -v /opt/kf5 /opt/kf5.old                         &amp;&amp;
install -v -dm755           $KF5_PREFIX/{etc,share} &amp;&amp;
ln -sfv /etc/dbus-1         $KF5_PREFIX/etc         &amp;&amp;
ln -sfv /usr/share/dbus-1   $KF5_PREFIX/share       &amp;&amp;
ln -sfv /usr/share/polkit-1 $KF5_PREFIX/share       &amp;&amp;
install -v -dm755           $KF5_PREFIX/lib         &amp;&amp;
ln -sfv /usr/lib/systemd    $KF5_PREFIX/lib</userinput></screen>

    </caution>

    <para>
      First, start a subshell that will exit on error:
    </para>


<screen><userinput>bash -e</userinput></screen>

    <para>
      Install all of the packages by running the following
      commands:
    </para>

<screen><userinput>while read -r line; do

    # Get the file name, ignoring comments and blank lines
    if $(echo $line | grep -E -q '^ *$|^#' ); then continue; fi
    file=$(echo $line | cut -d" " -f2)

    pkg=$(echo $file|sed 's|^.*/||')          # Remove directory
    packagedir=$(echo $pkg|sed 's|\.tar.*||') # Package directory

    name=$(echo $pkg|sed 's|-5.*$||') # Isolate package name

    tar -xf $file
    pushd $packagedir
<!--
      case $name in
        plasma-framework*)
          sed -i 's/${EGL_TARGET}/GL EGL/' src/declarativeimports/core/CMakeLists.txt ;;
      esac
-->
      mkdir build
      cd    build

      cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
            -DCMAKE_PREFIX_PATH=$QT5DIR        \
            -DCMAKE_BUILD_TYPE=Release         \
            -DBUILD_TESTING=OFF                \
            -Wno-dev ..
      make
      as_root make install
    popd
<!-- some packages end with files owned by root in $packagedir, so use as_root
     in the following -->
  as_root rm -rf $packagedir
  as_root /sbin/ldconfig

done &lt; frameworks-&kf5-version;.md5

exit</userinput></screen>

    <note>
      <para>
        Any modules that have been omitted can be installed later by
        using the same <command>mkdir build; cd build; cmake; make;
        make install</command> procedure as above.
      </para>
    </note>

    <para revision="sysv">
      Useless systemd units have been installed in
      <filename class="directory">$KF5_PREFIX/lib</filename>. Remove
      them now (as <systemitem class="username">root</systemitem>):
    </para>

<screen role="root"
        revision="sysv"><userinput>rm -rf $KF5_PREFIX/lib/systemd</userinput></screen>

    <para>
      Sometimes the installation paths are hardcoded into installed files.
      If the installed directory is not /usr, rename the directory and create a
      symlink:
    </para>

    <screen role="root"><userinput>mv -v /opt/kf5 /opt/kf5-&kf5-version;
ln -sfvn kf5-&kf5-version; /opt/kf5</userinput></screen>

  </sect2>

    <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DCMAKE_PREFIX_PATH=$QT5DIR</parameter>: This switch is used
      to allow cmake to find the proper Qt libraries.
    </para>

    <para>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
      to apply higher level of the compiler optimizations.
    </para>

    <para>
      <parameter>-DBUILD_TESTING=OFF</parameter>: This switch is used to prevent
      building test programs and libraries that are of no use to an end user.
    </para>

  </sect2>
  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          balooctl,
          baloo_file,
          baloo_file_extractor,
          baloosearch,
          balooshow,
          checkXML5,
          depdiagram-generate,
          depdiagram-generate-all,
          depdiagram-prepare,
          desktoptojson,
          gentrigrams,
          kactivities-cli,
          kapidox_generate,
          kate-syntax-highlighter,
          kbuildsycoca5,
          kcookiejar5,
          kdebugdialog5,
          kded5,
          kdeinit5,
          kdeinit5_shutdown,
          kdeinit5_wrapper,
          kf5-config,
          kf5kross,
          kgendesignerplugin,
          kglobalaccel5,
          kiconfinder5,
          kjs5,
          kjscmd5,
          kjsconsole,
          knewstuff-dialog,
          kpackagelauncherqml,
          kpackagetool5,
          kquitapp5,
          kreadconfig5,
          kshell5,
          ktelnetservice5,
          ktrash5,
          kwalletd5,
          kwallet-query,
          kwrapper5,
          kwriteconfig5,
          meinproc5,
          parsetrigrams,
          plasmapkg2,
          preparetips5,
          protocoltojson, and
          solid-hardware5
        </seg>
        <seg>
          libkdeinit5_klauncher.so,
          libKF5Activities.so,
          libKF5ActivitiesStats.so,
          libKF5Archive.so,
          libKF5Attica.so,
          libKF5AuthCore.so,
          libKF5Auth.so,
          libKF5Baloo.so,
          libKF5BluezQt.so,
          libKF5Bookmarks.so,
          libKF5CalendarCore.so,
          libKF5CalendarEvents.so,
          libKF5Codecs.so,
          libKF5Completion.so,
          libKF5ConfigCore.so,
          libKF5ConfigGui.so,
          libKF5ConfigWidgets.so,
          libKF5Contacts.so,
          libKF5CoreAddons.so,
          libKF5Crash.so,
          libKF5DAV.so,
          libKF5DBusAddons.so,
          libKF5Declarative.so,
          libKF5DNSSD.so,
          libKF5DocTools.so,
          libKF5Emoticons.so,
          libKF5FileMetaData.so,
          libKF5GlobalAccel.so,
          libKF5GuiAddons.so,
          libKF5Holidays.so,
          libKF5I18n.so,
          libKF5IconThemes.so,
          libKF5IdleTime.so,
          libKF5ItemModels.so,
          libKF5ItemViews.so,
          libKF5JobWidgets.so,
          libKF5JSApi.so,
          libKF5JsEmbed.so,
          libKF5JS.so,
          libKF5KCMUtils.so,
          libKF5KDELibs4Support.so,
          libKF5KHtml.so,
          libKF5KIOCore.so,
          libKF5KIOFileWidgets.so,
          libKF5KIOGui.so,
          libKF5KIONTLM.so,
          libKF5KIOWidgets.so,
          libKF5Kirigami2.so,
          libKF5KrossCore.so,
          libKF5KrossUi.so,
          libKF5MediaPlayer.so,
          libKF5NetworkManagerQt.so,
          libKF5NewStuffCore.so,
          libKF5NewStuff.so,
          libKF5Notifications.so,
          libKF5NotifyConfig.so,
          libKF5Package.so,
          libKF5Parts.so,
          libKF5PeopleBackend.so,
          libKF5People.so,
          libKF5PeopleWidgets.so,
          libKF5PlasmaQuick.so,
          libKF5Plasma.so,
          libKF5Plotting.so,
          libKF5Prison.so,
          libKF5Pty.so,
          libKF5Purpose.so,
          libKF5PurposeWidgets.so,
          libKF5QuickAddons.so,
          libKF5Runner.so,
          libKF5Service.so,
          libKF5Solid.so,
          libKF5SonnetCore.so,
          libKF5SonnetUi.so,
          libKF5Style.so,
          libKF5Su.so,
          libKF5SyntaxHighlighting.so,
          libKF5TextEditor.so,
          libKF5TextWidgets.so,
          libKF5ThreadWeaver.so,
          libKF5UnitConversion.so,
          libKF5Wallet.so,
          libKF5WaylandClient.so,
          libKF5WaylandServer.so,
          libKF5WidgetsAddons.so,
          libKF5WindowSystem.so,
          libKF5XmlGui.so,
          libKF5XmlRpcClient.so, and
          libkwalletbackend5.so
        </seg>
        <seg>
          /opt/kf5 (symlink to /opt/kf5-&kf5-version;) if installing in /opt
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="checkXML5">
        <term><command>checkXML5</command></term>
        <listitem>
          <para>
            is a tool to check for syntax errors in KDE DocBook XML files
          </para>
          <indexterm zone="kf5-frameworks checkXML5">
            <primary sortas="b-checkXML5">checkXML5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="depdiagram-generate">
        <term><command>depdiagram-generate</command></term>
        <listitem>
          <para>
            is a tool to generate a dependency diagram
          </para>
          <indexterm zone="kf5-frameworks depdiagram-generate">
            <primary sortas="b-depdiagram-generate">depdiagram-generate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="depdiagram-generate-all">
        <term><command>depdiagram-generate-all</command></term>
        <listitem>
          <para>
            is a tool to generate a dependency diagram for all frameworks at once
          </para>
          <indexterm zone="kf5-frameworks depdiagram-generate-all">
            <primary sortas="b-depdiagram-generate-all">depdiagram-generate-all</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="depdiagram-prepare">
        <term><command>depdiagram-prepare</command></term>
        <listitem>
          <para>
            is a tool to prepare dot files
          </para>
          <indexterm zone="kf5-frameworks depdiagram-prepare">
            <primary sortas="b-depdiagram-prepare">depdiagram-prepare</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="desktoptojson">
        <term><command>desktoptojson</command></term>
        <listitem>
          <para>
            is a tool to convert a .desktop file to a .json file
          </para>
          <indexterm zone="kf5-frameworks desktoptojson">
            <primary sortas="b-desktoptojson">desktoptojson</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kbuildsycoca5">
        <term><command>kbuildsycoca5</command></term>
        <listitem>
          <para>
            rebuilds the KService desktop file system configuration
       cache
          </para>
          <indexterm zone="kf5-frameworks kbuildsycoca5">
            <primary sortas="b-kbuildsycoca5">kbuildsycoca5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kcookiejar5">
        <term><command>kcookiejar5</command></term>
        <listitem>
          <para>
            is a command line interface to the HTTP cookie store used by KDE,
            a D-BUS service to store/retrieve/clean cookies
          </para>
          <indexterm zone="kf5-frameworks kcookiejar5">
            <primary sortas="b-kcookiejar5">kcookiejar5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kded5">
        <term><command>kded5</command></term>
        <listitem>
          <para>
            consolidates several small services in one process
          </para>
          <indexterm zone="kf5-frameworks kded5">
            <primary sortas="b-kded5">kded5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdeinit5">
        <term><command>kdeinit5</command></term>
        <listitem>
          <para>
            is a process launcher somewhat similar to the famous init used
            for booting UNIX
          </para>
          <indexterm zone="kf5-frameworks kdeinit5">
            <primary sortas="b-kdeinit5">kdeinit5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kf5-config">
        <term><command>kf5-config</command></term>
        <listitem>
          <para>
            is a command line program used to retrieve information about
            KDE installation or user paths
          </para>
          <indexterm zone="kf5-frameworks kf5-config">
            <primary sortas="b-kf5-config">kf5-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kf5kross">
        <term><command>kf5kross</command></term>
        <listitem>
          <para>
            executes kross scripts written in KDE Javascript, Python, Ruby,
            Java and Falcon
          </para>
          <indexterm zone="kf5-frameworks kf5kross">
            <primary sortas="b-kf5kross">kf5kross</primary>
          </indexterm>
        </listitem>
      </varlistentry>
<!--
      <varlistentry id="kgenapidox">
        <term><command>kgenapidox</command></term>
        <listitem>
          <para>
            is a tool to generate API documentation in the KDE style.
          </para>
          <indexterm zone="kf5-frameworks kgenapidox">
            <primary sortas="b-kgenapidox">kgenapidox</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="kgendesignerplugin">
        <term><command>kgendesignerplugin</command></term>
        <listitem>
          <para>
            generates widget plugins for Qt(TM) Designer
          </para>
          <indexterm zone="kf5-frameworks kgendesignerplugin">
            <primary sortas="b-kgendesignerplugin">kgendesignerplugin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kglobalaccel5">
        <term><command>kglobalaccel5</command></term>
        <listitem>
          <para>
            is a daemon use to register the key bindings and for getting
            notified when the action triggered
          </para>
          <indexterm zone="kf5-frameworks kglobalaccel5">
            <primary sortas="b-kglobalaccel5">kglobalaccel5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kjs5">
        <term><command>kjs5</command></term>
        <listitem>
          <para>
            is KDE ECMAScript/JavaScript engine
          </para>
          <indexterm zone="kf5-frameworks kjs5">
            <primary sortas="b-kjs5">kjs5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kjscmd5">
        <term><command>kjscmd5</command></term>
        <listitem>
          <para>
             is a tool for launching KJSEmbed scripts from the command line
          </para>
          <indexterm zone="kf5-frameworks kjscmd5">
            <primary sortas="b-kjscmd5">kjscmd5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kjsconsole">
        <term><command>kjsconsole</command></term>
        <listitem>
          <para>
            is a console for <command>kjs5</command>
          </para>
          <indexterm zone="kf5-frameworks kjsconsole">
            <primary sortas="b-kjsconsole">kjsconsole</primary>
          </indexterm>
        </listitem>
      </varlistentry>
<!--
      <varlistentry id="kmailservice5">
        <term><command>kmailservice5</command></term>
        <listitem>
          <para>
            is a mail service.
          </para>
          <indexterm zone="kf5-frameworks kmailservice5">
            <primary sortas="b-kmailservice5">kmailservice5</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="kpackagelauncherqml">
        <term><command>kpackagelauncherqml</command></term>
        <listitem>
          <para>
            is a commandline tool for launching kpackage QML application
          </para>
          <indexterm zone="kf5-frameworks kpackagelauncherqml">
            <primary sortas="b-kpackagelauncherqml">kpackagelauncherqml</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kpackagetool5">
        <term><command>kpackagetool5</command></term>
        <listitem>
          <para>
            is a command line kpackage tool
          </para>
          <indexterm zone="kf5-frameworks kpackagetool5">
            <primary sortas="b-kpackagetool5">kpackagetool5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kreadconfig5">
        <term><command>kreadconfig5</command></term>
        <listitem>
          <para>
            is a command line tool to retrieve values from KDE
            configuration files
          </para>
          <indexterm zone="kf5-frameworks kreadconfig5">
            <primary sortas="b-kreadconfig5">kreadconfig5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kshell5">
        <term><command>kshell5</command></term>
        <listitem>
          <para>
            start applications via kdeinit
          </para>
          <indexterm zone="kf5-frameworks kshell5">
            <primary sortas="b-kshell5">kshell5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ktelnetservice5">
        <term><command>ktelnetservice5</command></term>
        <listitem>
          <para>
            is a telnet service
          </para>
          <indexterm zone="kf5-frameworks ktelnetservice5">
            <primary sortas="b-ktelnetservice5">ktelnetservice5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ktrash5">
        <term><command>ktrash5</command></term>
        <listitem>
          <para>
            is a helper program to handle the KDE trash can
          </para>
          <indexterm zone="kf5-frameworks ktrash5">
            <primary sortas="b-ktrash5">ktrash5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kwalletd5">
        <term><command>kwalletd5</command></term>
        <listitem>
          <para>
           is the wallet manager daemon
          </para>
          <indexterm zone="kf5-frameworks kwalletd5">
            <primary sortas="b-kwalletd5">kwalletd5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kwriteconfig5">
        <term><command>kwriteconfig5</command></term>
        <listitem>
          <para>
            is a command line tool to write values in KDE
            configuration files
          </para>
          <indexterm zone="kf5-frameworks kwriteconfig5">
            <primary sortas="b-kwriteconfig5">kwriteconfig5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="meinproc5">
        <term><command>meinproc5</command></term>
        <listitem>
          <para>
            converts DocBook files to HTML
          </para>
          <indexterm zone="kf5-frameworks meinproc5">
            <primary sortas="b-meinproc5">meinproc5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="plasmapkg2">
        <term><command>plasmapkg2</command></term>
        <listitem>
          <para>
            is a tool to install, list, remove Plasma packages
          </para>
          <indexterm zone="kf5-frameworks plasmapkg2">
            <primary sortas="b-plasmapkg2">plasmapkg2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="preparetips5">
        <term><command>preparetips5</command></term>
        <listitem>
          <para>
            is a script to extract the text from a tips file
          </para>
          <indexterm zone="kf5-frameworks preparetips5">
            <primary sortas="b-preparetips5">preparetips5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="solid-hardware5">
        <term><command>solid-hardware5</command></term>
        <listitem>
          <para>
            is a command line tool to investigate available devices
         </para>
          <indexterm zone="kf5-frameworks solid-hardware5">
            <primary sortas="b-solid-hardware5">solid-hardware5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

   </variablelist>

  </sect2>

</sect1>