source: general/genutils/xterm.xml@ 852f5146

<?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 xterm-download-http " ">
  <!ENTITY xterm-download-ftp  "ftp://invisible-island.net/xterm/xterm-&xterm-version;.tgz">
  <!ENTITY xterm-md5sum        "b767d702e1464e16802b90c2187252c6">
  <!ENTITY xterm-size          "830 KB">
  <!ENTITY xterm-buildsize     "8.0 MB">
  <!ENTITY xterm-time          "0.1 SBU">
]>

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

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

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

  <indexterm zone="xterm2">
    <primary sortas="a-xterm2">xterm</primary>
  </indexterm>

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

    <para><application>xterm</application> is a terminal emulator for
    the X Window System.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="xorg7-lib"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="luit"/> (required in non-UTF-8 locales
    if the user wants TrueType fonts, and always required in Chinese, Japanese,
    and Korean locales). Configuration instructions below assume that Luit
    is installed.</para>

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

  </sect2>

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

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

<screen><userinput>sed -i '/v0/,+1s/new:/new:kb=^?:/' termcap &amp;&amp;
echo -e '\tkbs=\\177,' &gt;&gt;terminfo &amp;&amp;
TERMINFO=/usr/lib/terminfo ./configure $XORG_CONFIG \
    --enable-luit --enable-wide-chars \
    --with-app-defaults=$XORG_PREFIX/share/X11/app-defaults &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 &amp;&amp;
make install-ti</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed -i ... termcap</command>,
    <command>echo ... >>terminfo</command>: these commands modify the terminal
    description, so that the Backspace key is expected to send the character
    with ASCII code 127, for consistency with the Linux console.</para>

    <para><parameter>TERMINFO=/usr/lib/terminfo</parameter>: This ensures
    that the <command>xterm</command> terminfo file is installed to the
    system terminfo database when the installation prefix is not
    <filename class="directory">/usr</filename>.</para>

    <para><parameter>--with-app-defaults=...</parameter>: Sets the location
    for the <filename class="directory">app-defaults</filename>
    directory.</para>

    <para><parameter>--enable-luit</parameter>: Enables the luit filter for
    translation between Unicode (used by xterm internally in the configuration
    below) and the locale encoding. If <command>luit</command> is not found
    in the PATH, the default of
    <filename>/usr/X11R6/bin/luit</filename> will be used.</para>

    <para><parameter>--enable-wide-chars</parameter>: Adds support for wide
    characters.</para>

    <para><command>make install-ti</command>: This command installs corrected
    terminfo description files for use with
    <application>xterm</application>.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring xterm</title>

    <para>There are two ways to configure xterm.  You can add X resource
    definitions to the user's <filename>~/.Xresources</filename> file, or
    add them to the system-wide
    <filename>$XORG_PREFIX/share/X11/app-defaults/Xterm</filename> file.</para>

    <para>In order for xterm to follow the locale settings in the environment,
    use TrueType fonts, and follow the Linux convention about the code sent by
    the Backspace key, add the following definitions as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>cat &gt;&gt; $XORG_PREFIX/share/X11/app-defaults/XTerm &lt;&lt; "EOF"
*VT100*locale: true
*VT100*faceName: Monospace
*VT100*faceSize: 10
*backarrowKeyIsErase: true
*ptyInitialErase: true
EOF</userinput></screen>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>

      <seglistitem>
        <seg>resize, uxterm, and xterm</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="resize">
        <term><filename>resize</filename></term>
        <listitem>
          <para>prints a shell command for setting the TERM and TERMCAP
          environment  variables to indicate the current size of xterm
          window.</para>
          <indexterm zone="xterm2 resize">
            <primary sortas="b-resize">resize</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uxterm">
        <term><filename>uxterm</filename></term>
        <listitem>
          <para>is a wrapper script that modifies the current locale to use UTF-8
          and starts xterm with the proper settings.</para>
          <indexterm zone="xterm2 uxterm">
            <primary sortas="b-uxterm">uxterm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xterm-bin">
        <term><filename>xterm</filename></term>
        <listitem>
          <para>is a terminal emulator for the X Window System.</para>
          <indexterm zone="xterm2 xterm2">
            <primary sortas="b-xterm2">xterm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>