source: x/lib/gtksourceview5.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 gtksourceview5-download-http "&gnome-download-http;/gtksourceview/5.12/gtksourceview-&gtksourceview5-version;.tar.xz">
  <!ENTITY gtksourceview5-download-ftp  " ">
  <!ENTITY gtksourceview5-md5sum        "60ed6cd89cc877c2e7e08d314fa55e02">
  <!ENTITY gtksourceview5-size          "1.2 MB">
  <!ENTITY gtksourceview5-buildsize     "47 MB">
  <!ENTITY gtksourceview5-time          "0.2 SBU (with tests; both using parallelism=4)">
]>

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


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

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

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

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

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk4"/> and
      <xref linkend="pcre2"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/>,
      <!--<xref linkend="sysprof"/>,-->
      <xref linkend="vala"/>,
      <xref linkend="valgrind"/>,
      <xref linkend="vulkan-loader"/>, and
      <ulink url="&sysprof-url;">sysprof</ulink>
      <!--<ulink url="https://www.vulkan.org/">Vulkan</ulink>-->
    </para>

  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release .. &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>

    <para>
      <option>-Ddocumentation=true</option>: Use this switch if you have
      <xref linkend="gi-docgen"/> installed and wish to generate the API
      documentation.
    </para>

    <para>
      <option>-Dsysprof=true</option>: Use this switch if you have
      <ulink url="&sysprof-url;">sysprof</ulink> installed and wish to build
      with sysprof profiler support.
    </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>
          libgtksourceview-5.so
        </seg>
        <seg>
          /usr/include/gtksourceview-5 and
          /usr/share/gtksourceview-5
        </seg>
      </seglistitem>
    </segmentedlist>

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

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