source: lxqt/apps/qterminal.xml@ d9c3e477

<?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 qterminal-download-http "https://github.com/lxde/qterminal/releases/download/&qterminal-version;/qterminal-&qterminal-version;.tar.xz">
  <!ENTITY qterminal-download-ftp  " ">
  <!ENTITY qterminal-md5sum        "6c27ac08df0b6c8322729e0ad981873d">
  <!ENTITY qterminal-size          "100 KB">
  <!ENTITY qterminal-buildsize     "3.7 MB (add 1.3 MB for the API documentation)">
  <!ENTITY qterminal-time          "0.3 SBU (with the API documentation)">
]>

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

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

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

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

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

    <para>
      The <application>qterminal</application> package contains a Qt widget
      based terminal emulator for <application>Qt</application> with support
      for multiple tabs.
    </para>

    &lfs7a_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="liblxqt"/> and
      <xref linkend="qtermwidget"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> and
      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
      for documentation, and
      <xref linkend="git"/> (to download translation files) or
      <xref linkend="lxqt-l10n"/> (to add localization files)
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/qterminal"/>
    </para>
  </sect2>

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

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

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

cmake -DCMAKE_BUILD_TYPE=Release          \
      -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
      -DPULL_TRANSLATIONS=no              \
      ..       &amp;&amp;

make</userinput></screen>

    <para>
      If you have <xref linkend="doxygen"/> installed, and wish to create the
      API documentation, issue:
    </para>

<screen><userinput>doxygen ../Doxyfile</userinput></screen>

    <para>
      The html API documentation has been generated with the previous command.
      Now, if you also have <xref linkend="texlive"/> (or <xref
      linkend="tl-installer"/>) installed, and wish to create the pdf API
      reference manual, issue:
    </para>

<screen><userinput>make -C docs/latex</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>

    <para>
      To install the html API documentation, if you opted to generate it, issue,
      as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/qterminal-&qterminal-version;/{html,pdf} &amp;&amp;
cp -vr docs/html/* /usr/share/doc/qterminal-&qterminal-version;/html</userinput></screen>

    <para>
      The pdf API reference manual can be installed with, as
      the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m644    docs/latex/refman.pdf \
                    /usr/share/doc/qterminal-&qterminal-version;/pdf</userinput></screen>

    <para>
      If <xref linkend="lxqt-l10n"/> is not installed in <filename
      class="directory">/usr</filename>, the translation files are not found.
      To cure that, run, as the <systemitem class="username">root</systemitem>:
    </para>

<screen role="root"><userinput>if [ "$LXQT_PREFIX" != /usr ]; then
  ln -s $LXQT_PREFIX/share/qterminal /usr/share
fi</userinput></screen>

    <para>
      Note that the above instruction works only if <envar>LXQT_PREFIX</envar>
      has been set as explained in <xref linkend="lxqt-pre-install"/>.
    </para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DPULL_TRANSLATIONS=no</parameter>: Removes the need for
      <xref linkend="git"/>, which would otherwise be requested to download
      the translation files.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          qterminal
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/doc/qterminal-&qterminal-version; (if the documentation
          is installed)
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="qterminal-prog">
        <term><command>qterminal</command></term>
        <listitem>
          <para>
            is a <application>Qt</application> based lightweight terminal
            emulator.
          </para>
          <indexterm zone="qterminal qterminal-prog">
            <primary sortas="b-qterminal">qterminal</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>