source: kde/kf5-apps/khelpcenter.xml@ 39eac921

<?xml version="1.0" encoding="UTF-8"?>
<!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 khelpcenter-download-http "&kf5apps-download-http;/khelpcenter-&kf5apps-version;.tar.xz">
  <!ENTITY khelpcenter-download-ftp  " ">
  <!ENTITY khelpcenter-md5sum        "03ef818c0e43e350609d4399e49c3959">
  <!ENTITY khelpcenter-size          "4.2 MB">
  <!ENTITY khelpcenter-buildsize     "29 MB">
  <!ENTITY khelpcenter-time          "0.2 SBU (using parallelism=4)">
]>

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


  <title>Khelpcenter-&kf5apps-version;</title>

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

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

    <para>
      <application>Khelpcenter</application> is an application
      to show KDE Applications' documentation.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kf5-frameworks"/>,
      <xref linkend="libxml2"/>, and
      <xref linkend="xapian"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="qtwebengine"/>
    </para>

<!-- Is this true any more ???
    <note>
      <para>
        Khelpcenter does not provide the plugin to display the manual pages.
        It is found in kio-extras, another <ulink
        url="&kf5apps-download-http;">KDE application</ulink>.
        Depending on what is installed on your system, other dependencies
        may be needed to build it.
      </para>
    </note>
-->
  </sect2>

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=$KF6_PREFIX \
      -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 Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          khelpcenter
        </seg>
        <seg>
          None
        </seg>
        <seg>
          $KF6_PREFIX/share/khelpcenter,
          $KF6_PREFIX/share/doc/HTML/*/{khelpcenter,fundamentals,onlinehelp}
        </seg>
      </seglistitem>
    </segmentedlist>

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

     <varlistentry id="khelpcenter-prog">
        <term><command>khelpcenter</command></term>
        <listitem>
          <para>
            is the help viewer for KDE applications
          </para>
          <indexterm zone="khelpcenter khelpcenter-prog">
            <primary sortas="b-khelpcenter">khelpcenter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>