source: lxqt/apps/juffed.xml@ e6441b2

<?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 juffed-download-http "http://anduin.linuxfromscratch.org/sources/BLFS/conglomeration/juffed/juffed-&juffed-version;.tar.xz">
  <!ENTITY juffed-download-ftp  " ">
  <!ENTITY juffed-md5sum        "5d211f5aadcb3d7365b5a6127d3d275f">
  <!ENTITY juffed-size          "1.3 MB">
  <!ENTITY juffed-buildsize     "22 MB">
  <!ENTITY juffed-time          "0.8 SBU">
]>

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

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

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

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

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

    <para>
      The <application>JuffEd</application> package is a Qt based editor with
      support for multiple tabs. It is simple and clear, but very powerful.
      It supports language syntax highlighting, auto-indents in accordance with
      file type, code blocks folding, matching braces highlighting with instant
      jumps between them, powerful search and replacing text using regular
      expressions (including multiline ones) with the opportunity to use
      matches \1, \2, &hellip; in substitutions, a terminal emulator, saving
      named sessions and many other features.
    </para>

    &lfs78_checked;

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

    <para>
      The source tarball shown above was created by the BLFS team by cloning
      the source code repository, finding the correct version to rename
      accordingly the source code directory, removing <filename
      class="directory">.git</filename> directory and <filename
      class="directory">.gitignore</filename> file, and finally making the
      compressed tarball. No other modification has been made.
    </para>

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="qtermwidget"/> (for the terminal)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="desktop-file-utils"/> and
      <ulink url="http://cihar.com/software/enca/">Enca</ulink>
    </para>

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

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

    <para>
      For compilation with <application>Qt4</application>, see <quote>Command
      Explanations</quote> below. Install
      <application>JuffEd</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 \
      -DLIB_INSTALL_DIR=/usr/lib  \
      -DBUILD_TERMINAL=ON         \
      -DUSE_QT5=true              \
      ..       &amp;&amp;

make</userinput></screen>

    <para>
      The choice of <filename class="directory">/usr</filename> 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_TERMINAL=ON</parameter>: This switch is used in order
      to enable building the terminal. Toggle to <quote>OFF</quote> or remove
      the switch, if you do not wish it.
    </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 Directory</segtitle>

      <seglistitem>
        <seg>
          juffed
        </seg>
        <seg>
          libjuff.so,
          libjuffed-engine-qsci.so and
          plugins under /usr/lib/juffed/plugins
        </seg>
        <seg>
          /usr/{include,lib,share}/juffed
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="juffed-prog">
        <term><command>juffed</command></term>
        <listitem>
          <para>
            is a <application>Qt</application> based text editor.
          </para>
          <indexterm zone="juffed juffed-prog">
            <primary sortas="b-juffed">juffed</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="libjuffed-engine-qsci">
        <term><filename class="libraryfile">libjuffed-engine-qsci.so</filename></term>
        <listitem>
          <para>
            contains the <application>QScintilla</application> bindings.
          </para>
          <indexterm zone="juffed libjuffed-engine-qsci">
            <primary sortas="c-libjuffed-engine-qsci">libjuffed-engine-qsci.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>