source: gnome/core/gtksourceview.xml@ 4c2be438

<?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 gtksourceview-download-http 
           "&gnome-download-http;/gtksourceview/3.4/gtksourceview-&gtksourceview-version;.tar.xz">
  <!ENTITY gtksourceview-download-ftp  
           "&gnome-download-ftp;/gtksourceview/3.4/gtksourceview-&gtksourceview-version;.tar.xz">
  <!ENTITY gtksourceview-md5sum        "637a8a5b909cfd7e77ca0e414a225e24">
  <!ENTITY gtksourceview-size          "1.2 MB">
  <!ENTITY gtksourceview-buildsize     "33 MB">
  <!ENTITY gtksourceview-time          "0.3 SBU">
]>

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

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

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

  <indexterm zone="gtksourceview">
    <primary sortas="a-gtksourceview">gtksourceview</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>

    &lfs70_checked;

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

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

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

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

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite. If you have the
    optional dependencies to build the test programs installed,
    <emphasis role='strong'>after the package is installed</emphasis> you can
    change to the <filename class='directory'>tests</filename> directory in the
    source tree and issue <command>./test-widget</command>. This will test the
    functionality of the
    <filename class='libraryfile'>libgtksourceview-3.0</filename> library.</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>

<!--    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-prefix.xml"/> -->

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          libgtksourceview-3.0.so
        </seg>
        <seg>
          /usr/include/gtksourceview-3.0,
          /usr/share/gtksourceview-3.0 and
          /usr/share/gtk-doc/html/gtksourceview-3.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>