source: x/installing/xterm.xml@ 2128523

<?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 xterm-download-http " ">
  <!ENTITY xterm-download-ftp  "ftp://invisible-island.net/xterm/xterm-&xterm-version;.tgz">
  <!ENTITY xterm-md5sum        "c75cdbf9395bbc2cd69863fbe7c2e019">
  <!ENTITY xterm-size          "745 KB">
  <!ENTITY xterm-buildsize     "7.1 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>
    <keywordset>
      <keyword role="package">xterm-&xterm-version;.tar</keyword>
      <keyword role="ftpdir">xterm</keyword>
    </keywordset>
  </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><xref linkend="x-window-system"/> and
    <xref linkend="pkgconfig"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="luit"/></para>

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

  </sect2>

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

    <para>Correct the PROJECTROOT variable with the following command:</para>

<screen><userinput>sed -i 's@/usr/X11R6@/<replaceable>&lt;PREFIX&gt;</replaceable>@' main.h</userinput></screen>

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

<screen><userinput>./configure --prefix=<replaceable>&lt;PREFIX&gt;</replaceable> --sysconfdir=/etc \
    --localstatedir=/var --enable-luit --with-wide-chars &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><parameter>--enable-luit</parameter>: enables the luit filter for
    unicode translation.</para>

    <para><parameter>--with-wide-chars</parameter>: adds support for wide
    characters.</para>

    <para><command>sed -i 's@/usr/X11R6@/<replaceable>&lt;PREFIX&gt;</replaceable>@' main.h</command>: This command
    corrects the PROJECTROOT definition to match that of the installed X Window
    System.</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><replaceable>&lt;PREFIX&gt;</replaceable>/lib/X11/app-defaults/Xterm</filename> file.</para>

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

<screen role="root"><userinput>cat &gt;&gt; <replaceable>&lt;PREFIX&gt;</replaceable>/lib/X11/app-defaults/XTerm &lt;&lt; "EOF"
*VT100*locale: true
*VT100*faceName: Monospace
*VT100*faceSize: 10
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 to start xterm with the proper settings in
          UTF-8 locales.</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>