source: kde5/frameworks/kio.xml@ 3899973

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

  <!ENTITY kio-download-http "&kf5-download-http;/kio-&kf5-version;.tar.xz">
  <!ENTITY kio-download-ftp  "&kf5-download-ftp;/kio-&kf5-version;.tar.xz">
  <!ENTITY kio-md5sum        "9aaf9448ceb4d834dcbff35c157a0bcd">
  <!ENTITY kio-size          "2.5 MB">
  <!ENTITY kio-buildsize     "60 MB">
  <!ENTITY kio-time          "3.2 SBU">
]>

<sect1 id="kio" xreflabel="KIO-&kf5-version;">
  <?dbhtml filename="kio.html"?>

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

  <title>KIO-&kf5-version;</title>

  <indexterm zone="kio">
    <primary sortas="a-KIO">KIO</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to KIO</title>

    <para>
      The <application>KIO</application> package contains a library
      that provides network transparent access to files and data.
    </para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="attica5"/>,
      <xref linkend="kbookmarks"/>,
      <xref linkend="kjobwidgets"/>,
      <xref linkend="kwallet"/> and
      <xref linkend="solid"/>
    </para>

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

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

  <sect2 role="installation">
    <title>Installation of KIO</title>

    <para>
      Install <application>KIO</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX    \
      -DCMAKE_BUILD_TYPE=Release            \
      -DSYSCONF_INSTALL_DIR=$KF5_SYSCONFDIR \
      -DLIB_INSTALL_DIR=lib                 \
      -DBUILD_TESTING=OFF                   \
      -DQT_PLUGIN_INSTALL_DIR=&qt5-plugins-dir; \
      -DECM_MKSPECS_INSTALL_DIR=&qt5-mkspecs-dir; \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/cmake-release.xml"/>

    <para>
      <parameter>-DSYSCONF_INSTALL_DIR=$KF5_SYSCONFDIR</parameter>: This switch
      is used to set correct XDG configuration directory.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/kf5-libdir.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/kf5-tests.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/qt5-plugins-dir.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/qt5-mkspecs-dir.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          kcookiejar5, kmailservice5 and ktelnetservice5
        </seg>
        <seg>
          libKF5KIOCore.so, libKF5KIOFileWidgets.so, libKF5KIONTLM.so
          and libKF5KIOWidgets.so
        </seg>
        <seg>
          $KF5_PREFIX/include/KF5/{kio,KIOCore},
          $KF5_PREFIX/include/KF5/{KIOFileWidgets,KIOWidgets},
          $KF5_PREFIX/lib/cmake/KF5KIO,
          $KF5_PREFIX/share/doc/HTML/*/kioslave5 and
          $KF5_PREFIX/share/kf5/kcookiejar
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>