source: gnome/core/vte.xml@ c64a089

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY vte-download-http "http://ftp.gnome.org/pub/GNOME/sources/vte/0.11/vte-&vte-version;.tar.bz2">
<!ENTITY vte-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/vte/0.11/vte-&vte-version;.tar.bz2">
<!ENTITY vte-md5sum "5eb73c7de433fb6e53ac4378df9d23b5">
<!ENTITY vte-size "952 KB">
<!ENTITY vte-buildsize "24 MB">
<!ENTITY vte-time "0.7 SBU">
]>

<sect1 id="vte" xreflabel="VTE-&vte-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="vte.html"?>
<title>VTE-&vte-version;</title>

<sect2>
<title>Introduction to <application>VTE</application></title>

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

<sect3><title>Package information</title>
<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>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>
</sect3>

<sect3><title><application>VTE</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="gtk2"/> and 
<xref linkend="python"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="gtk-doc"/> and 
<ulink url="http://www.pygtk.org/">PyGTK</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>VTE</application></title>

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

<screen><userinput><command>sed -i -e 's%\\177:%&amp;kh=\\EOH:@7=\\EOF:%g' termcaps/xterm &amp;&amp;
./configure --prefix=/usr --libexecdir=/usr/sbin --disable-gtk-doc &amp;&amp;
make</command></userinput></screen>

<para>This package does not come with a test suite.</para>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>sed -i -e ...</command>: The Home and End keys are broken in 
the <filename>xterm</filename> termcap file. This <command>sed</command> 
command fixes them.</para>

<para><parameter>--libexecdir=/usr/sbin</parameter>: This switch puts
libexec files in <filename class="directory">/usr/sbin</filename> instead of
<filename class="directory">/usr/libexec</filename>.</para>

<para><option>--disable-gtk-doc</option>: This switch prevents the
building of documentation. Remove it if you have 
<application>GTK-Doc</application> installed and wish to rebuild the 
documentation.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>VTE</application> package contains 
<filename class="libraryfile">libvte</filename> libraries, 
<command>vte</command>, 
<command>gnome-pty-helper</command>, 
auxillary <application>VTE</application> programs,  scripts and 
the <filename class="libraryfile">vtemodule</filename> 
<application>Python</application> module.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>vte libraries</title>
<para><filename class="libraryfile">libvte</filename> libraries provide the 
functions necessary to implement a <quote>termcap file</quote> for terminal 
emulators.</para></sect3>

<sect3><title>vte</title>
<para><command>vte</command> is a test application for the 
<application>VTE</application> libraries.</para></sect3>

<sect3><title>gnome-pty-helper</title>
<para><command>gnome-pty-helper</command> is a setuid helper for opening 
ptys.</para></sect3>

</sect2>

</sect1>