source: kde/add/kate.xml@ 0d7900a

<?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 kate-download-http "&kde-download-http;&kde-version;/src/kate-&kde-version;.tar.xz">
  <!ENTITY kate-download-ftp  "&kde-download-ftp;&kde-version;/src/kate-&kde-version;.tar.xz">
  <!ENTITY kate-md5sum        "dfb02f35f1aaf4e9083c16e7f797bede">
  <!ENTITY kate-size          "2.1 MB">
  <!ENTITY kate-buildsize     "75 MB">
  <!ENTITY kate-time          "4.6 SBU">
]>

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

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

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

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

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

    <para>This package provides two texteditors: Kate and KWrite. Kate is a
      powerful programmer's text editor with syntax highlighting for many
      programming and scripting languages. KWrite is the lightweight cousin of Kate.</para>

    &lfs72_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">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/kate-&kdeutils-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">Kate Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kdelibs"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://qjson.sourceforge.net/">qjson</ulink> and
      <ulink url="&kde-download-http;&kde-version;/src/">PyKDE4</ulink>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/kate"/>
    </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=&kde-dir; \
      -DCMAKE_BUILD_TYPE=Release \
      -DINSTALL_PYTHON_FILES_IN_PYTHON_PREFIX=TRUE \
      .. &amp;&amp;
make</userinput></screen>

    <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>

    <para><option>-DINSTALL_PYTHON_FILES_IN_PYTHON_PREFIX=TRUE</option>: This option is
    set to install the KDE Python objects in the correct place.</para>

  </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>libkateinterfaces.so, libkatepartinterfaces.so,
        libkdeinit4_kate.so, libkdeinit4_kwrite.so and several in
        &kde-dir;/lib/kde4</seg>
        <seg>&kde-dir;/include/kate and several in &kde-dir;/share</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 the KDE text editor.</para>
          <indexterm zone="kate kate-prog">
            <primary sortas="b-kate">kate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>