source: temp-tools/common/tcl.xml@ da56a22

<?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">
  <!ENTITY % patches-entities SYSTEM "../../patches.ent">
  %general-entities;
  %patches-entities;
]>

<sect1 id="ch-temp-tools-tcl" role="wrap">
  <?dbhtml filename="tcl.html"?>

  <title>Tcl-&tcl-version;</title>

  <indexterm zone="ch-temp-tools-tcl">
    <primary sortas="a-Tcl">Tcl</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Tcl package contains the Tool Command Language.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>Not checked yet</seg>
        <seg>Not checked yet</seg>
      </seglistitem>
    </segmentedlist>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Bash, Binutils, Coreutils, Diffutils,
        GCC, Glibc, Grep, Make, and Sed</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para os="a">This package and the next two (Expect and DejaGNU) are installed
    to support running the test suites for GCC and Binutils. Installing
    three packages for testing purposes may seem excessive, but it is very
    reassuring, if not essential, to know that the most important tools are
    working properly. Even if the test suites are not run in this chapter
    (they are not mandatory), these packages are required to run the test
    suites in <xref linkend="chapter-building-system"/>.</para>

    <para os="b">Prepare Tcl for compilation:</para>

<screen><userinput>cd unix
./configure --prefix=/tools</userinput></screen>

    <para os="c">Build the package:</para>

<screen os="d"><userinput>make</userinput></screen>

    <para os="e">To test the results, issue: <userinput>TZ=UTC make
    test</userinput>. The Tcl test suite is known to experience failures
    under certain host conditions that are not fully understood.
    Therefore, test suite failures here are not surprising, and are not
    considered critical. The <parameter>TZ=UTC</parameter> parameter sets
    the time zone to Coordinated Universal Time (UTC), also known as
    Greenwich Mean Time (GMT), but only for the duration of the test suite
    run. This ensures that the clock tests are exercised correctly.
    Details on the <envar>TZ</envar> environment variable are provided in
    <xref linkend="chapter-bootscripts"/>.</para>

    <para os="f">Install the package:</para>

<screen os="g"><userinput>make install</userinput></screen>

    <warning os="h">
      <para><emphasis>Do not</emphasis> remove the <filename
      class="directory">tcl&tcl-version;</filename> source directory yet,
      as the next package will need its internal headers.</para>
    </warning>

    <para os="i">Set a variable containing the full path of the current directory.
    The next package, Expect, will use this variable to find Tcl's headers.</para>

<screen os="j"><userinput>cd ..
export TCLPATH=`pwd`</userinput></screen>

    <para os="k">Now make a necessary symbolic link:</para>

<screen os="l"><userinput>ln -s tclsh8.4 /tools/bin/tclsh</userinput></screen>

  </sect2>

  <sect2 id="contents-tcl" role="content">
    <title>Contents of Tcl</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed library</segtitle>

      <seglistitem>
        <seg>tclsh (link to tclsh8.4) and tclsh8.4</seg>
        <seg>libtcl8.4.so</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="tclsh8.4">
        <term><command>tclsh8.4</command></term>
        <listitem>
          <para>The Tcl command shell</para>
          <indexterm zone="ch-temp-tools-tcl tclsh8.4">
            <primary sortas="b-tclsh8.4">tclsh8.4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tclsh">
        <term><command>tclsh</command></term>
        <listitem>
          <para>A link to tclsh8.4</para>
          <indexterm zone="ch-temp-tools-tcl tclsh">
            <primary sortas="b-tclsh">tclsh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtcl8.4.so">
        <term><filename class="libraryfile">libtcl8.4.so</filename></term>
        <listitem>
          <para>The Tcl library</para>
          <indexterm zone="ch-temp-tools-tcl libtcl8.4.so">
            <primary sortas="c-libtcl8.4.so">libtcl8.4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>