source: x/lib/tepl.xml@ f67c5c8

<?xml version="1.0" encoding="UTF-8"?>
<!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 tepl-download-http "&gnome-download-http;/tepl/6.8/tepl-&tepl-version;.tar.xz">
  <!ENTITY tepl-download-ftp  " ">
  <!ENTITY tepl-md5sum        "5d29b2c9032a1ba2d33ef9c9c9c7de79">
  <!ENTITY tepl-size          "164 KB">
  <!ENTITY tepl-buildsize     "13 MB (with tests)">
  <!ENTITY tepl-time          "0.3 SBU (with tests)">

]>

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


  <title>Tepl-&tepl-version;</title>

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

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

    <para>
      The <application>Tepl</application> package contains a library that eases
      the development of GtkSourceView-based text editors and IDEs.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="icu"/>,
      <xref linkend="libgedit-amtk"/>,
      <xref linkend="libgedit"/>, and
      <xref linkend="uchardet"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> (for documentation) and
      <xref linkend="valgrind"/>
    </para>

  </sect2>

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

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

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

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk_doc=false     \
            .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <parameter>-Dgtk_doc=false</parameter>: Disables building the API
      documentation. Remove if you have <xref linkend="gtk-doc"/> installed
      and wish to build the API documentation.
    </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>
          libtepl-6.so
        </seg>
        <seg>
          /usr/include/tepl-6 and
          /usr/share/gtk-doc/html/tepl-6.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libtepl-6">
        <term><filename class="libraryfile">libtepl-6.so</filename></term>
        <listitem>
          <para>
            contains convenience functions for GtkSourceView4-based programs
          </para>
          <indexterm zone="tepl libtepl-6">
            <primary sortas="c-libtepl-6">libtepl-6.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>