source: postlfs/editors/kate.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 kate-download-http "&kf5apps-download-http;/kate-&kf5apps-version;.tar.xz">
  <!ENTITY kate-download-ftp  " ">
  <!ENTITY kate-md5sum        "d368f1cb7acc4cb1f9f3eadb6fbd37ac">
  <!ENTITY kate-size          "8.0 MB">
  <!ENTITY kate-buildsize     "252 MB">
  <!ENTITY kate-time          "1.0 SBU (using parallelism=4)">
]>

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


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

  <indexterm zone="kate">
    <primary sortas="a-Kate">Kate</primary>
  </indexterm>

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

    <para>
      The <application>Kate</application> package contains an advanced
      KF6 based graphical text editor.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kf5-frameworks"/>
    </para>
<!--
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://libgit2.github.com/">libgit2</ulink>
    </para>
-->
  </sect2>

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

    <para>
      Install <application>Kate</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 Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          kate and kwrite
        </seg>
        <seg>
          Several plugins under $KF6_PREFIX/lib/plugins
        </seg>
        <seg>
          $KF6_PREFIX/lib/plugins/ktexteditor,
          $KF6_PREFIX/lib/plugins/plasma/dataengine,
          $KF6_PREFIX/share/doc/HTML/*/{kate,katepart,kwrite},
          $KF6_PREFIX/share/{kateproject,katexmltools}, and
          $KF6_PREFIX/share/plasma/plasmoids/org.kde.plasma.katesessions
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="kate-prog">
        <term><command>kate</command></term>
        <listitem>
          <para>
            is an advanced text editor for kde
          </para>
          <indexterm zone="kate kate-prog">
            <primary sortas="b-kate">kate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kwrite">
        <term><command>kwrite</command></term>
        <listitem>
          <para>
            is a text editor for KDE, that is a light version of
            <command>kate</command>
          </para>
          <indexterm zone="kate kwrite">
            <primary sortas="b-kwrite">kwrite</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>