source: general/prog/tk.xml@ ff769b8c

<?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 tk-download-http "http://prdownloads.sourceforge.net/tcl/tk&tk-version;-src.tar.gz">
<!ENTITY tk-download-ftp "ftp://ftp.us.xemacs.org/pub/tcl/tcl8_4/tk&tk-version;-src.tar.gz">
<!ENTITY tk-md5sum "1b64258abaf258e9a86f331d8de17a71">
<!ENTITY tk-size "3.2 MB">
<!ENTITY tk-buildsize "23.3 MB">
<!ENTITY tk-time "0.35 SBU">
]>

<sect1 id="tk" xreflabel="Tk-&tk-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="tk.html"?>
<title>Tk-&tk-version;</title>
<indexterm zone="tk">
<primary sortas="a-Tk">Tk</primary></indexterm>

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

<para>The <application>Tk</application> package contains a
<acronym>TCL</acronym> <acronym>GUI</acronym> Toolkit.</para>

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

<sect3><title><application>Tk</application> dependencies</title>
<sect4><title>Required</title>
<para>X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>) and 
<xref linkend="tcl"/></para></sect4>
</sect3>

</sect2>

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

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

<screen><userinput><command>export VERSION=&tk-version; &amp;&amp;
export V=`echo $VERSION | cut -d "." -f 1,2` &amp;&amp;
export DIR=$PWD &amp;&amp;
cd unix &amp;&amp;
./configure --prefix=/usr --enable-threads &amp;&amp;
make &amp;&amp;
sed -i "s:${DIR}/unix:/usr/lib:" tkConfig.sh &amp;&amp;
sed -i "s:${DIR}:/usr/include/tk${V}:" tkConfig.sh</command></userinput></screen>

<para>If you run <command>make test</command> to run the test suite,
ensure you do it from an X Window display device with the 
<acronym>GLX</acronym> extensions loaded, else the tests will hang.</para>

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

<screen><userinput role='root'><command>make install &amp;&amp;
install -d /usr/include/tk${V}/unix &amp;&amp;
install -m644 *.h /usr/include/tk${V}/unix/ &amp;&amp;
install -d /usr/include/tk${V}/generic &amp;&amp;
install -m644 ../generic/*.h /usr/include/tk${V}/generic/ &amp;&amp;
rm -f /usr/include/tk${V}/generic/{tk,tkDecls,tkPlatDecls}.h &amp;&amp;
ln -nsf ../../include/tk${V} /usr/lib/tk${V}/include &amp;&amp;
ln -sf libtk${V}.so /usr/lib/libtk.so &amp;&amp;
ln -sf wish${V} /usr/bin/wish</command></userinput></screen>

<para>Clean up the unprivileged user's environment using the following
commands:</para>

<screen><userinput><command>unset VERSION &amp;&amp;
unset V &amp;&amp;
unset DIR</command></userinput></screen>

<!--
<caution><para>If you build the package as an ordinary user and then switch to 
root to install the package, ensure you set the environment variables
<envar>V</envar> and <envar>VERSION</envar> before running the installation
commands.</para></caution>
-->

</sect2>

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

<para><parameter>--enable-threads</parameter>: This switch forces the package
to build with thread support.</para>

<para><command>sed -i ...</command>: The <application>Tk</application> package
assumes that the source that is used to build <application>Tk</application> is
always kept around for compiling packages that depend on
<application>Tk</application>. These <command>sed</command>'s remove the
reference to the build directory and replace them by saner system wide
locations.</para>

<para><command>install ...</command>: These commands install the internal
headers into a system-wide location.</para>

<para><command>ln -sf ...</command>: These commands create compatibility
symbolic links.</para>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>

<seglistitem>
<seg>wish and wish8.4</seg>
<seg>libtk.so and libtkstub8.4.a</seg>
<seg>/usr/include/tk8.4 and /usr/lib/tk8.4</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="wish">
<term><command>wish</command></term>
<listitem><para> is a symlink to the <command>wish8.4</command> program.</para>
<indexterm zone="tk wish">
<primary sortas="b-wish">wish</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="wish8.4">
<term><command>wish8.4</command></term>
<listitem><para> is a simple shell containing the
<application>Tk</application> toolkit that creates a main window and
then processes <application>Tcl</application> commands.</para>
<indexterm zone="tk wish8.4">
<primary sortas="b-wish8.4">wish8.4</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libtk">
<term><filename role="library">libtk.so</filename></term>
<listitem><para>contains the <acronym>API</acronym> functions required
by <application>Tk</application>.</para>
<indexterm zone="tk libtk">
<primary sortas="c-libtk">libtk.so</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>