source: gnome/core/vte.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 vte-download-http "&gnome-download-http;/vte/0.32/vte-&vte-version;.tar.xz">
  <!ENTITY vte-download-ftp  "&gnome-download-ftp;/vte/0.32/vte-&vte-version;.tar.xz">
  <!ENTITY vte-md5sum        "d1eac0bdf6230952b5deba9957d5c8c9">
  <!ENTITY vte-size          "962 KB">
  <!ENTITY vte-buildsize     "20 MB">
  <!ENTITY vte-time          "0.4 SBU">
]>

<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>

    &lfs70_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"/> 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;/vte"/></para>

  </sect2>

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

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

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

    <para>This package does not come with a test suite.</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>--libexecdir=/usr/lib/vte</parameter>: This parameter
    causes <command>gnome-pty-helper</command> to be installed in the preferred location of
    <filename class="directory">/usr/lib/vte</filename>
    instead of <filename class="directory">/usr/libexec</filename>.</para>

    <para><option>--with-glX</option>: This
    parameter can be passed to the <command>configure</command> script
    to enable additional drawing methods in the
    <application>VTE</application> library.</para>

    <para><option>--enable-introspection</option>: This option enables
    gobject-introspection 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"/>

    <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>

      <seglistitem>
        <seg>
          vte2_90
        </seg>
        <seg>
          libvte2_90.so
        </seg>
        <seg>
          /usr/include/vte-2.90, /usr/lib/vte and
          /usr/share/gtk-doc/html/vte-2.90
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="vte-prog">
        <term><command>vte2_90</command></term>
        <listitem>
          <para>is a test application for the <application>VTE</application>
          libraries.</para>
          <indexterm zone="vte vte-prog">
            <primary sortas="b-vte">vte2_90</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>