source: lxqt/apps/qscintilla.xml@ 79ba2ea

<?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 qscintilla-download-http "&sourceforge-repo;/pyqt/QScintilla-gpl-&qscintilla-version;.tar.gz">
  <!ENTITY qscintilla-download-ftp  " ">
  <!ENTITY qscintilla-md5sum        "24c4033cbf20223eb73a33af9c037862">
  <!ENTITY qscintilla-size          "2.4 MB">
  <!ENTITY qscintilla-buildsize     "37 MB (with documentation)">
  <!ENTITY qscintilla-time          "1 SBU (with documentation)">
]>

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

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

  <title>QScintilla-gpl-&qscintilla-version;</title>

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

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

    <para>
      <application>QScintilla</application> is a port to
      <application>Qt</application> of <ulink
      url="http://www.scintilla.org/">Scintilla</ulink>. As well as features
      found in standard text editing components, it includes features
      especially useful when editing and debugging source code: language
      syntax styling, error indicators, code completion, call tips, code
      folding, margins can contain markers like those used in debuggers to
      indicate breakpoints and the current line, recordable macros, multiple
      views and, of course, printing.
    </para>

    &lfs77_checked; &gcc5_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch (if building with <application>Qt5</application>):
          <ulink url="&patch-root;/QScintilla-gpl-&qscintilla-version;-fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink
      url="http://riverbankcomputing.co.uk/software/pyqt/intro">PyQt</ulink>
      (for <application>Python</application> <application>Qt</application>
      bindings)
    </para>

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

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

    <para>
      If building with <application>Qt5</application>, run the following commnd:
    </para>

<screen><userinput>patch -Np1 -i ../QScintilla-gpl-&qscintilla-version;-fixes-1.patch</userinput></screen>

    <para>
      If <application>Qt4</application> and <application>Qt5</application> are
      installed, choose which one you prefer, by running <command>source
      setqt4</command> or <command>source setqt5</command>, respectivelly.
    </para>

    <note>
      <para>
        The instructions in this page are just for the
        <application>QScintilla</application> application. Code is included in
        the tarball for  <application>QScintilla Qt Designer</application>
        plugin and <application>Python</application> bindings.
      </para>
    </note>

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

<screen><userinput>cd Qt4Qt5             &amp;&amp;

qmake qscintilla.pro  &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>

    <para>
      If you wish to install the documentation, issue, as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m755 -d $QT5DIR/share/doc/QScintilla-&qscintilla-version; &amp;&amp;
install -v -m644    ../doc/html-Qt4Qt5/* \
                    $QT5DIR/share/doc/QScintilla-&qscintilla-version;</userinput></screen>

    <para>
       if building with <application>Qt5</application>. For
       <application>Qt4</application> build, replace <envar>QT5DIR</envar> with
       <envar>QT4DIR</envar>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          $QT5DIR/lib/libqt5scintilla2.so or $QT4DIR/lib/libqtscintilla2.so
        </seg>
        <seg>
          $QT5DIR/{include/Qsci,qsci,share/doc/QScintilla-&qscintilla-version;}
          or
          $QT4DIR/{include/Qsci,qsci,share/doc/QScintilla-&qscintilla-version;}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libqt5scintilla2">
        <term><filename class="libraryfile">libqt5scintilla2.so</filename></term>
        <listitem>
          <para>
            contains the <application>QScintilla</application>
            <application>Qt5</application> API functions.
          </para>
          <indexterm zone="qscintilla libqt5scintilla2">
            <primary sortas="c-libqt5scintilla2">libqt5scintilla2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libqscintilla2">
        <term><filename class="libraryfile">libqscintilla2.so</filename></term>
        <listitem>
          <para>
            contains the <application>QScintilla</application>
            <application>Qt4</application> API functions.
          </para>
          <indexterm zone="qscintilla libqscintilla2">
            <primary sortas="c-libqscintilla2">libqscintilla2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>