source: kde5/frameworks/intro.xml@ 71a44f0

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE partintro 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;
]>

<sect1 id="frameworks-intro">
  <?dbhtml filename="frameworks-intro.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Introduction to KDE Frameworks 5</title>

  <para>
    <application>KDE Frameworks 5</application> is a collection of
    libraries based on top of <application>Qt5</application> and
    QML that can be used independently of
    <application>KDE</application>.
  </para>

  <important>
    <para>
      The instructions for <application>KDE Frameworks 5</application>
      packages assume that <xref linkend="qt5"/> was built with
      recommended dependencies installed.
    </para>
  </important>

  <sect2>
    <title>Build Order</title>

  <para>
    <application>KDE Frameworks 5</application> packages are listed
    in the recommended and tested build order based on dependencies.
  </para>

  </sect2>

  <sect2>
    <title>Installing in /usr</title>

    <para>
      One option is to install <application>KDE Frameworks 5</application>
      into the <filename class="directory">/usr</filename> hierarchy.
      This creates a simpler setup but makes it more difficult to try
      multiple versions of <application>KDE Frameworks</application>.
    </para>

<screen><userinput>export KF5_PREFIX=/usr
export KF5_SYSCONFDIR=/etc</userinput></screen>

    <para>
      It is a good idea to add the following variables to your
      system or personal profile:
    </para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/kf5.sh &lt;&lt; "EOF"
<literal># Begin /etc/profile.d/kf5.sh

export KF5_PREFIX=/usr
export KF5_SYSCONFDIR=/etc

export QT_SELECT=qt5

pathappend /usr/lib/qt5/plugins        QT_PLUGIN_PATH
pathappend /opt/qt5/plugins            QT_PLUGIN_PATH

pathappend /usr/lib/qt5/qml            QML_IMPORT_PATH
pathappend /opt/qt5/qml                QML_IMPORT_PATH

pathappend /usr/lib/qt5/qml            QML2_IMPORT_PATH
pathappend /opt/qt5/qml                QML2_IMPORT_PATH

# End /etc/profile.d/kf5.sh</literal>
EOF</userinput></screen>

    <warning>
      <para>
        If <application>KDE4</application> is installed in
        <filename class="directory">/usr</filename>, some packages
        from this chapter might overwrite some programs installed
        by <application>KDE4</application> packages.
      </para>
    </warning>

  </sect2>

  <sect2>
    <title>Installing in /opt</title>

    <para>
      A method of building multiple versions installs
      <application>KDE Frameworks 5</application> in the
      <filename class="directory">/opt</filename> hierarchy:
    </para>

<screen><userinput>export KF5_PREFIX=/opt/kf5
export KF5_SYSCONFDIR=$KF5_PREFIX/etc</userinput></screen>

    <para>
      If you are not installing <application>KDE Frameworks 5</application>
      in <filename class="directory">/usr</filename>, you will need to
      make some additional configuration changes. Best practice is to add
      those to your system or personal profile:
    </para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/kf5.sh &lt;&lt; "EOF"
<literal># Begin /etc/profile.d/kf5.sh

export KF5_PREFIX=/opt/kf5
export KF5_SYSCONFDIR=$KF5_PREFIX/etc

export QT_SELECT=qt5

pathappend $KF5_PREFIX               CMAKE_PREFIX_PATH
pathappend $KF5_PREFIX/bin           PATH
pathappend $KF5_PREFIX/lib/pkgconfig PKG_CONFIG_PATH
pathappend $KF5_PREFIX/lib/python&python2-majorver; PYTHONPATH

pathappend /etc/xdg                  XDG_CONFIG_DIRS
pathappend $KF5_PREFIX/etc/xdg       XDG_CONFIG_DIRS
pathappend /usr/share                XDG_DATA_DIRS
pathappend $KF5_PREFIX/share         XDG_DATA_DIRS

pathappend /usr/lib/qt5/plugins        QT_PLUGIN_PATH
pathappend /opt/qt5/plugins            QT_PLUGIN_PATH
pathappend $KF5_PREFIX/lib/qt5/plugins QT_PLUGIN_PATH

pathappend /usr/lib/qt5/qml            QML_IMPORT_PATH
pathappend /opt/qt5/qml                QML_IMPORT_PATH
pathappend $KF5_PREFIX/lib/qt5/qml     QML_IMPORT_PATH

pathappend /usr/lib/qt5/qml            QML2_IMPORT_PATH
pathappend /opt/qt5/qml                QML2_IMPORT_PATH
pathappend $KF5_PREFIX/lib/qt5/qml     QML2_IMPORT_PATH

# End /etc/profile.d/kf5.sh</literal>
EOF</userinput></screen>

    <para>
      Expand your <filename>/etc/ld.so.conf</filename> file:
    </para>

<screen role="root"><userinput>cat &gt;&gt; /etc/ld.so.conf &lt;&lt; "EOF"
<literal># Begin KF5 addition

/opt/kf5/lib

# End KF5 addition</literal>
EOF</userinput></screen>

    <indexterm zone="frameworks-intro">
      <primary sortas="e-etc-ld.so.conf">/etc/ld.so.conf</primary>
    </indexterm>

    <para>
      Several <application>KDE Frameworks 5</application> packages install files into
      <application>D-Bus</application> and <application>Polkit</application> directories.
      When installing <application>KDE Frameworks 5</application> in a location other than
      <filename class="directory">/usr</filename>, <application>D-Bus</application> and
      <application>Polkit</application> need to be able to find these files. The easiest
      way to achieve this is to create the following symlinks (as the
      <systemitem class="username">root</systemitem> user):
    </para>

<screen role="root"><userinput>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>

    <para>
      Some packages may also install icons from the "hicolor" icon set. Since that
      icon set is used by many packages, it is a good idea to create a
      symlink to the one in <filename class="directory">/usr/share</filename>
      to avoid having multiple installations of <xref linkend="hicolor-icon-theme"/>.
      Run the following commands as the <systemitem class="username">root</systemitem>
      user:
    </para>

<screen role="root"><userinput>install -v -dm755 $KF5_PREFIX/share/icons &amp;&amp;
ln -sfv /usr/share/icons/hicolor $KF5_PREFIX/share/icons</userinput></screen>

    <tip>
      <para>
        Sometimes, the installation paths are hardcoded into installed files.
        This is the reason why <filename class="directory">/opt/kf5</filename>
        is used as installation prefix instead of <filename
        class="directory">/opt/kf5-&kf5-version;</filename>. After installing
        <application>KDE Frameworks</application>, you may rename the directory
        and create a symlink:
      </para>

<screen role="root"><userinput>mv /opt/kf5{,-&kf5-version;}
ln -sfv kf5-&kf5-version; /opt/kf5</userinput></screen>

      <para>
        Later on, you may want to install other versions of
        <application>KDE Frameworks 5</application>. To do that, just remove
        the symlink and use <filename class="directory">/opt/kf5</filename>
        as the prefix again. Which version of
        <application>KDE Frameworks 5</application> you use depends only on
        where the symlink points to. No other reconfiguration will be needed.
      </para>
    </tip>

  </sect2>

</sect1>