source: kde/kuserfeedback.xml@ bac7c05

<?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 kuserfeedback-download-http "https://download.kde.org/stable/kuserfeedback/kuserfeedback-&kuserfeedback-version;.tar.xz">
  <!ENTITY kuserfeedback-download-ftp  " ">
  <!ENTITY kuserfeedback-md5sum        "d5e787de6cf0001f23133694dbffd96f">
  <!ENTITY kuserfeedback-size          "228 KB">
  <!ENTITY kuserfeedback-buildsize     "24 MB">
  <!ENTITY kuserfeedback-time          "0.2 SBU (using parallelism=4)">
]>

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

  <title>kuserfeedback-&kuserfeedback-version;</title>

  <indexterm zone="kuserfeedback">
    <primary sortas="a-kuserfeedback">kuserfeedback</primary>
  </indexterm>

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

    <para>
      The <application>kuserfeedback</application> package contains a
        framework for collecting user feedback for applications via telemetry
      and surveys.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="extra-cmake-modules"/> and
      <xref linkend="qt5"/>
    </para>

  </sect2>

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TESTING=OFF         \
      -Wno-dev .. &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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          UserFeedbackConsole and 
          userfeedbackctl
        </seg>
        <seg>
          libKUserFeedbackCore.so and
          libKUserFeedbackWidgets.so
        </seg>
        <seg>
          /usr/include/KUserFeedback,
          /usr/lib/qml/org/kde/userfeedback,
          /usr/lib/cmake/KUserFeedback,
          /usr/share/KDE/UserFeedbackConsole, and
          /usr/share/qlogging-categories5
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>