source: x/lib/gtksourceview4.xml@ 3fb307f

<?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 gtksourceview4-download-http
    "&gnome-download-http;/gtksourceview/4.8/gtksourceview-&gtksourceview4-version;.tar.xz">
  <!ENTITY gtksourceview4-download-ftp
    "&gnome-download-ftp;/gtksourceview/4.8/gtksourceview-&gtksourceview4-version;.tar.xz">
  <!ENTITY gtksourceview4-md5sum        "2bf056caaae27654ec3a5930dd5597d3">
  <!ENTITY gtksourceview4-size          "1.1 MB">
  <!ENTITY gtksourceview4-buildsize     "71 MB (with tests)">
  <!ENTITY gtksourceview4-time          "0.1 SBU (with tests; both using parallelism=4)">
]>

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


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

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

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

    <para>
      The <application>GtkSourceView</application> package contains
      libraries used for extending the <application>GTK+</application>
      text functions to include syntax highlighting.
    </para>

    &lfs112_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/gtksourceview4-&gtksourceview4-version;-buildfix-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="vala"/>,
      <xref linkend="valgrind"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="itstool"/>,
      <xref linkend="fop"/> (or
      <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink>),
      and
      <ulink url="https://glade.gnome.org/">Glade</ulink>
    </para>

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

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

<!--
    <para>
      First, apply a patch to prevent a race condition:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../gtksourceview4-&gtksourceview4-version;-buildfix-1.patch</userinput></screen>
-->

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

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

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

    <para>
      To test the results, issue <command>ninja test</command>. The tests need
      to be run in a graphical environment.
    </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>

    <para>
      <option>-Dgtk_doc=true</option>: This option is normally
      used if <application>GTK-Doc</application> is installed and you wish
      to rebuild and install the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgtksourceview-4.so
        </seg>
        <seg>
          /usr/{include,share,share/gtk-doc/html}/gtksourceview-4
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgtksourceview-4">
        <term><filename class="libraryfile">libgtksourceview-4.so</filename></term>
        <listitem>
          <para>
            contains function extensions for the GtkTextView widget
          </para>
          <indexterm zone="gtksourceview4 libgtksourceview-4">
            <primary sortas="c-libgtksourceview-4">libgtksourceview-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>