Textual updates thanks to Kevin Buckley.
[linux_from_scratch.git] / chapter05 / tcl.xml
blobf2265fd8d0098367b027919c4e6250a16c9e1f59
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4   <!ENTITY % general-entities SYSTEM "../general.ent">
5   %general-entities;
6 ]>
8 <sect1 id="ch-tools-tcl" role="wrap">
9   <?dbhtml filename="tcl.html"?>
11   <sect1info condition="script">
12     <productname>tcl</productname>
13     <productnumber>&tcl-version;</productnumber>
14     <address>&tcl-url;</address>
15   </sect1info>
17   <title>Tcl-&tcl-version;</title>
19   <indexterm zone="ch-tools-tcl">
20     <primary sortas="a-Tcl">Tcl</primary>
21   </indexterm>
23   <sect2 role="package">
24     <title/>
26     <para>The <application>Tcl</application> package contains the Tool Command Language,
27     a robust general-purpose scripting language. The <application>Expect</application> package
28     is written in the <application>Tcl</application> language.</para>
30     <segmentedlist>
31       <segtitle>&buildtime;</segtitle>
32       <segtitle>&diskspace;</segtitle>
34       <seglistitem>
35         <seg>&tcl-ch5-sbu;</seg>
36         <seg>&tcl-ch5-du;</seg>
37       </seglistitem>
38     </segmentedlist>
40   </sect2>
42   <sect2 role="installation">
43     <title>Installation of Tcl</title>
45     <para>This package and the next two (Expect and DejaGNU) are
46     installed to support running the test suites for GCC and Binutils and other
47     packages.  Installing three packages for testing purposes may seem
48     excessive, but it is very reassuring, if not essential, to know that the
49     most important tools are working properly. Even if the test suites are not
50     run in this chapter (they are not mandatory), these packages are required
51     to run the test suites in <xref linkend="chapter-building-system"/>.</para>
53     <para>Note that the Tcl package used here is a minimal version needed
54     to run the LFS tests.  For the full package, see the  
55     <ulink url='&blfs-book;general/tcl.html'>BLFS Tcl procedures</ulink>.</para>
57     <para>Prepare Tcl for compilation:</para>
59 <screen><userinput remap="configure">cd unix
60 ./configure --prefix=/tools</userinput></screen>
62     <para>Build the package:</para>
64 <screen><userinput remap="make">make</userinput></screen>
66     <para>Compilation is now complete. As discussed earlier, running the test
67     suite is not mandatory for the temporary tools here in this chapter. To run
68     the Tcl test suite anyway, issue the following command:</para>
70 <screen><userinput remap="test">TZ=UTC make test</userinput></screen>
72     <para>The Tcl test suite may experience failures under certain host
73     conditions that are not fully understood. Therefore, test suite failures
74     here are not surprising, and are not considered critical. The
75     <parameter>TZ=UTC</parameter> parameter sets the time zone to Coordinated
76     Universal Time (UTC), but only
77     for the duration of the test suite run. This ensures that the clock tests
78     are exercised correctly. Details on the <envar>TZ</envar> environment
79     variable are provided in <xref linkend="chapter-config"/>.</para>
81     <para>Install the package:</para>
83 <screen><userinput remap="install">make install</userinput></screen>
85     <para>Make the installed library writable so debugging symbols can
86     be removed later:</para>
88 <screen><userinput remap="install">chmod -v u+w /tools/lib/libtcl&tcl-major-version;.so</userinput></screen>
90     <para>Install Tcl's headers. The next package, Expect, requires them
91     to build.</para>
93 <screen><userinput remap="install">make install-private-headers</userinput></screen>
95     <para>Now make a necessary symbolic link:</para>
97 <screen><userinput remap="install">ln -sv tclsh&tcl-major-version; /tools/bin/tclsh</userinput></screen>
99   </sect2>
101   <sect2 id="contents-tcl" role="content">
102     <title>Contents of Tcl</title>
104     <segmentedlist>
105       <segtitle>Installed programs</segtitle>
106       <segtitle>Installed library</segtitle>
108       <seglistitem>
109         <seg>tclsh (link to tclsh&tcl-major-version;) and tclsh&tcl-major-version;</seg>
110         <seg>libtcl&tcl-major-version;.so, libtclstub&tcl-major-version;.a</seg>
111       </seglistitem>
112     </segmentedlist>
114     <variablelist>
115       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
116       <?dbfo list-presentation="list"?>
117       <?dbhtml list-presentation="table"?>
119       <varlistentry id="tclsh&tcl-major-version;">
120         <term><command>tclsh&tcl-major-version;</command></term>
121         <listitem>
122           <para>The Tcl command shell</para>
123           <indexterm zone="ch-tools-tcl tclsh&tcl-major-version;">
124             <primary sortas="b-tclsh&tcl-major-version;">tclsh&tcl-major-version;</primary>
125           </indexterm>
126         </listitem>
127       </varlistentry>
129       <varlistentry id="tclsh">
130         <term><command>tclsh</command></term>
131         <listitem>
132           <para>A link to tclsh&tcl-major-version;</para>
133           <indexterm zone="ch-tools-tcl tclsh">
134             <primary sortas="b-tclsh">tclsh</primary>
135           </indexterm>
136         </listitem>
137       </varlistentry>
139       <varlistentry id="libtcl&tcl-major-version;.so">
140         <term><filename class="libraryfile">libtcl&tcl-major-version;.so</filename></term>
141         <listitem>
142           <para>The Tcl library</para>
143           <indexterm zone="ch-tools-tcl libtcl&tcl-major-version;.so">
144             <primary sortas="c-libtcl&tcl-major-version;.so">libtcl&tcl-major-version;.so</primary>
145           </indexterm>
146         </listitem>
147       </varlistentry>
149       <varlistentry id="libtclstub&tcl-major-version;.a">
150         <term><filename class="libraryfile">libtclstub&tcl-major-version;.a</filename></term>
151         <listitem>
152           <para>The Tcl Stub library</para>
153           <indexterm zone="ch-tools-tcl libtclstub&tcl-major-version;.a">
154             <primary sortas="c-libtclstub&tcl-major-version;.a">libtclstub&tcl-major-version;.a</primary>
155           </indexterm>
156         </listitem>
157       </varlistentry>
159     </variablelist>
161   </sect2>
163 </sect1>