source: kde/kf5-apps/konsole5.xml@ 52b9d551

<?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 konsole5-download-http "&kf5apps-download-http;/konsole-&kf5apps-version;.tar.xz">
  <!ENTITY konsole5-download-ftp  " ">
  <!ENTITY konsole5-md5sum        "9c978fbdf16353cf5d49b6d40bd8158d">
  <!ENTITY konsole5-size          "1.7 MB">
  <!ENTITY konsole5-buildsize     "53 MB">
  <!ENTITY konsole5-time          "0.5 SBU (using parallism=4)">
]>

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


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

  <indexterm zone="konsole5">
    <primary sortas="a-Konsole">Konsole</primary>
  </indexterm>

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

    <para>
      The <application>Konsole</application> package is a KF5 based terminal
      emulator.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Optional patch:
          <ulink url="&patch-root;/konsole-&kf5apps-version;-scrollbar-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

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

  </sect2>

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

    <note>
      <para>
        In non-plasma environments, the konsole scrollbar and its
        handle do not show up well.  If desired, apply the optional patch to
        the package:
      </para>

      <screen><userinput>patch -Np1 -i ../konsole-&kf5apps-version;-scrollbar-1.patch</userinput></screen>

      <para>
        The patch makes the scrollbar light gray with a small white border. The
        handle is dark gray.  If desired, the colors may be changed to taste by
        editing the patch.
      </para>
    </note>

    <para>
      Install <application>Konsole</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         \
      -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>
          konsole and konsoleprofile
        </seg>
        <seg>
          libkdeinit5_konsole.so and libkonsoleprivate.so
        </seg>
        <seg>
          $KF5_PREFIX/share/doc/HTML/*/konsole,
          $KF5_PREFIX/share/konsole, and
          $KF5_PREFIX/share/kxmlgui5/konsole
        </seg>
      </seglistitem>
    </segmentedlist>

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

     <varlistentry id="konsole5-prog">
        <term><command>konsole</command></term>
        <listitem>
          <para>
             is an X terminal emulation which provides a command-line
             interface
          </para>
          <indexterm zone="konsole5 konsole5-prog">
            <primary sortas="b-konsole">konsole</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="konsoleprofile5">
        <term><command>konsoleprofile</command></term>
        <listitem>
          <para>
            is a command-line tool to change the current tab's profile
            options
          </para>
          <indexterm zone="konsole5 konsoleprofile5">
            <primary sortas="b-konsoleprofile">konsoleprofile</primary>
          </indexterm>
        </listitem>
      </varlistentry>


    </variablelist>

  </sect2>

</sect1>