source: general/prog/tk.xml@ 7368969

<?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 tk-download-http "&sourceforge-repo;/tcl/tk&tk-version;-src.tar.gz">
  <!ENTITY tk-download-ftp  "">
  <!-- might be useful again in the future
  <!ENTITY tk-download-ftp  "&gentoo-ftp-repo;/tk&tk-version;-src.tar.gz">-->
  <!ENTITY tk-md5sum        "a01640176845c1f654a412cfc9bab13b">
  <!ENTITY tk-size          "3.7 MB">
  <!ENTITY tk-buildsize     "28 MB">
  <!ENTITY tk-time          "0.3 SBU">

  <!-- Ensure this is updated when Tk moves from the 8.5.x branch -->
  <!ENTITY tk-ver           "8.5">
]>

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

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

  <title>Tk-&tk-version;</title>

  <indexterm zone="tk">
    <primary sortas="a-Tk">Tk</primary>
  </indexterm>

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

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

    &lfs71_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

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

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

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

  </sect2>

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

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

<screen><userinput>cd unix &amp;&amp;
./configure --prefix=/usr \
            --enable-threads \
            --mandir=/usr/share/man &amp;&amp;
make &amp;&amp;
sed -e "s@^\(TK_SRC_DIR='\).*@\1/usr/include'@" \
    -e "/TK_B/s@='\(-L\)\?.*unix@='\1/usr/lib@" \
    -i tkConfig.sh</userinput></screen>

    <para>
      Running the tests is not recommended. Some tests may crash your X
      Server. To test the results anyway, issue: <command>make test</command>.
      Ensure you run it from an X Window display device with the GLX extensions
      loaded, otherwise the tests will hang.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install &amp;&amp;
make install-private-headers &amp;&amp;
ln -v -sf wish&tk-ver; /usr/bin/wish &amp;&amp;
chmod -v 755 /usr/lib/libtk&tk-ver;.so</userinput></screen>

  </sect2>

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

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

    <para>
      <command>make install-private-headers</command>: This command is
      used to install the <application>Tk</application> library interface
      headers used by other packages if they link to the
      <application>Tk</application> library.
    </para>

    <para>
      <command>ln -v -sf wish&tk-ver; /usr/bin/wish</command>: This
      command is used to create a compatibility symbolic link to the
      <command>wish&tk-ver;</command> file as many packages expect a file
      named <command>wish</command>.
    </para>

    <para>
      <command>sed -e ... tkConfig.sh</command>: The
      <application>Tk</application> package expects that its source tree is
      preserved so that packages depending on it for their compilation
      can utilize it. This <command>sed</command> removes the references to the
      build directory and replaces them with saner system-wide locations.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          wish and wish&tk-ver;
        </seg>
        <seg>
          libtk&tk-ver;.so and libtkstub&tk-ver;.a
        </seg>
        <seg>
          /usr/lib/tk&tk-ver;
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

      <varlistentry id="wish-eight">
        <term><command>wish&tk-ver;</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 wish-eight">
            <primary sortas="b-wish&tk-ver;">wish&tk-ver;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>