source: lxqt/apps/qtermwidget.xml@ a7035bb

<?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 qtermwidget-download-http "https://github.com/qterminal/qtermwidget/releases/download/&qtermwidget-version;/qtermwidget-&qtermwidget-version;.tar.xz">
  <!ENTITY qtermwidget-download-ftp  " ">
  <!ENTITY qtermwidget-md5sum        "763ce418ef6b7167cea6c01e3a97f5f4">
  <!ENTITY qtermwidget-size          "156 KB">
  <!ENTITY qtermwidget-buildsize     "5.1 MB">
  <!ENTITY qtermwidget-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      As the name suggests, the <application>qtermwidget</application> is a
      terminal widget for <application>Qt</application>.
    </para>

    &lfs77_checked; &gcc5_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/> and
      <xref linkend="qt5"/> or
      <xref linkend="qt4"/>

    </para>

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

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

    <para>
      If you have <application>Qt4</application> and
      <application>Qt5</application> installed, run <command>source
      setqt4</command> or <command>source setqt5</command>, respectively, in
      order to link <application>qtermwidget</application> to the one of your
      choice. Following instructions are for <application>Qt5</application>
      linking. For compilation with <application>Qt4</application>, see
      <quote>Command Explanations</quote>, below. Install
      <application>qtermwidget</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=/usr \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      -DBUILD_DESIGNER_PLUGIN=0   \
      -DUSE_QT5=true              \
      ..       &amp;&amp;

make</userinput></screen>

    <para>
      The choice of <filename class="directory">/usr</filename> for prefix is
      due to the general characteristics of this program, which can be used
      without <application>LXQt</application>.
    </para>

    <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="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DBUILD_DESIGNER_PLUGIN=0</parameter>: This switch is
      necessary, because building the Qt designer plugin is not supported for
      <application>Qt5</application> yet. Toggle to 1 or remove, if you prefer
      to use <application>Qt4</application>.
    </para>

    <para>
      <parameter>-DUSE_QT5=true</parameter>: This switch is used in order to
      build this application linked to <application>Qt5</application>. Toggle
      to <quote>false</quote>, if you prefer to use
      <application>Qt4</application>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libqtermwidget5.so or
          libqtermwidget4.so and
          /usr/lib/qt4/plugins/designer/libqtermwidget4plugin.so
        </seg>
        <seg>
          /usr/{include,share{/cmake,}}/qtermwidget5 or
          /usr/{include,share{/cmake,}}/qtermwidget4
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libqtermwidget5-lib">
        <term><filename class="libraryfile">libqtermwidget5.so</filename></term>
        <listitem>
          <para>
            contains the <application>libqtermwidget5</application> API functions.
          </para>
          <indexterm zone="qtermwidget libqtermwidget5-lib">
            <primary sortas="c-libqtermwidget5">libqtermwidget5.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libqtermwidget4-lib">
        <term><filename class="libraryfile">libqtermwidget4.so</filename></term>
        <listitem>
          <para>
            contains the <application>libqtermwidget4</application> API functions.
          </para>
          <indexterm zone="qtermwidget libqtermwidget4-lib">
            <primary sortas="c-libqtermwidget4">libqtermwidget4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libqtermwidget4plugin-lib">
        <term><filename class="libraryfile">libqtermwidget4plugin.so</filename></term>
        <listitem>
          <para>
            contains the <application>qtermwidget Qt4 designer plugin</application>.
          </para>
          <indexterm zone="qtermwidget libqtermwidget4plugin-lib">
            <primary sortas="c-libqtermwidget4plugin">libqtermwidget4plugin.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>