source: gnome/platform/vte.xml@ 9d6c260

<?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 vte-download-http "&gnome-download-http;/vte/0.56/vte-&vte-version;.tar.xz">
  <!ENTITY vte-download-ftp  "&gnome-download-ftp;/vte/0.56/vte-&vte-version;.tar.xz">
  <!ENTITY vte-md5sum        "67d3c07cfd59bfe1872a95dcc22feeff">
  <!ENTITY vte-size          "1.1 MB">
  <!ENTITY vte-buildsize     "41 MB (with tests)">
  <!ENTITY vte-time          "0.7 SBU (with tests)">
  <!-- Consolidating Tests/No Tests in GNOME sections for consistency. -->

  <!-- For "Contents" and "Short Descriptions" sections -->
  <!ENTITY vte-nano          "91">
]>

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

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

  <title>VTE-&vte-version;</title>

  <indexterm zone="vte">
    <primary sortas="a-VTE">VTE</primary>
  </indexterm>

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

    <para>
      The <application>VTE</application> package contains a termcap
      file implementation for terminal emulators.
    </para>

    &lfs84_checked;

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

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="vala"/>, and
      <ulink url="http://glade.gnome.org/">Glade</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of VTE</title>
    <!-- with 0.56.0, not needed any more.
    <para>
      First, fix compilation of a Vala program with newer versions of
      Vala (0.43 and more):
    </para>

<!- - Upstream fix: - ->
<screen><userinput>sed -e '/bool audible/i\    public int dummy;' \
    -i bindings/vala/app.vala</userinput></screen>
-->
    <para>
      Install <application>VTE</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr          \
            --sysconfdir=/etc      \
            --disable-static       \
            --enable-introspection &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue <command>make check</command>.
    </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>

    <para>
      <parameter>--enable-introspection</parameter>: This switch enables
      <application>Gobject Introspection</application> bindings.
      Remove if you don't have <xref linkend="gobject-introspection"/>
      installed.
    </para>

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

    <para>
      <option>--without-gnutls</option>: Add this switch if you don't
      have <xref linkend="gnutls"/> installed.
    </para>

    <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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

<!-- EDITORS NOTE:
     vte installs a file into /etc/profile.d (/etc/profile.d/vte.sh) so that
     the environment is suitable for running with it's quirks.
-->
      <seglistitem>
        <seg>
          vte-2.&vte-nano;
        </seg>
        <seg>
          libvte-2.&vte-nano;.so
        </seg>
        <seg>
          /usr/include/vte-2.&vte-nano; and
          /usr/share/gtk-doc/html/vte-2.&vte-nano;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="vte291">
        <term><command>vte-2.&vte-nano;</command></term>
        <listitem>
          <para>
            is a test application for the <application>VTE</application>
            libraries.
          </para>
          <indexterm zone="vte vte291">
            <primary sortas="b-vte2-&vte-nano;">vte-2.&vte-nano;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libvte291">
        <term><filename class="libraryfile">libvte-2.&vte-nano;.so</filename></term>
        <listitem>
          <para>
            is a library which implements a terminal emulator
            widget for <application>GTK+ 3</application>.
          </para>
          <indexterm zone="vte libvte291">
            <primary sortas="c-libvte2-&vte-nano;">libvte-2.&vte-nano;.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>