source: x/lib/libgedit-gtksourceview.xml

<?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 libgedit-gtksourceview-download-http "https://github.com/gedit-technology/libgedit-gtksourceview/releases/download/&libgedit-gtksourceview-version;/libgedit-gtksourceview-&libgedit-gtksourceview-version;.tar.xz">
  <!ENTITY libgedit-gtksourceview-download-ftp  " ">
  <!ENTITY libgedit-gtksourceview-md5sum        "d92e9d2b10478569e0b02fa347b6ef5f">
  <!ENTITY libgedit-gtksourceview-size          "636 KB">
  <!ENTITY libgedit-gtksourceview-buildsize     "22 MB (with tests)">
  <!ENTITY libgedit-gtksourceview-time          "0.4 SBU (with tests)">

]>

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


  <title>libgedit-gtksourceview-&libgedit-gtksourceview-version;</title>

  <indexterm zone="libgedit">
    <primary sortas="a-libgedit-gtksourceview">libgedit-gtksourceview</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libgedit-gtksourceview</title>

    <para>
      The <application>libgedit-gtksourceview</application> package
      provides a library that extends GtkTextView.
      This library adds support for syntax highlighting, undo/redo,
      file loading and saving, search and replace, a
      completion system, printing, displaying line numbers, and
      other features typical of a source code editor.
    </para>

    &lfs121_checked;

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

    <bridgehead renderas="sect3">libgedit-gtksourceview Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/> and
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libgedit-gtksourceview</title>

    <para>
      Install <application>libgedit-gtksourceview</application> by
      running the following commands:
    </para>

<screen><userinput>mkdir build-libgedit &amp;&amp;
cd    build-libgedit &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>
          libgedit-gtksourceview-300.so
        </seg>
        <seg>
          /usr/include/libgedit-gtksourceview-300 and
          /usr/share/libgedit-gtksourceview-300
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgedit-gtksourceview-300">
        <term><filename class="libraryfile">
           libgedit-gtksourceview-300.so</filename></term>
        <listitem>
          <para>
            contains convenience functions for text editing.
          </para>
          <indexterm zone="libgedit libgedit-gtksourceview-300">
            <primary sortas="c-liblibgedit-gtksourceview-300">
              liblibgedit-gtksourceview-300.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>