source: BOOK/testsuite-tools/common/expect.xml@ fd5c672

<?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;
]>

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

  <title>Expect-&expect-version;</title>

  <indexterm zone="ch-testsuite-tools-expect">
    <primary sortas="a-Expect">Expect</primary>
  </indexterm>

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

    <para>The Expect package contains a program for carrying out scripted
    dialogues with other interactive programs.</para>

  </sect2>

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

    <para os="s1">The following sed tells <command>configure</command> to look
    for libraries in ${libdir}, not just in /tools/lib:</para>

<screen os="s2"><userinput>sed -i '/EXP_LIB_SPEC=/s@${exec_prefix}/lib@${libdir}@' configure</userinput></screen>

    <para os="a">Fix a bug that can result in false failures during the GCC
    test suite run:</para>

<screen os="b"><userinput>patch -Np1 -i ../&expect-spawn-patch;</userinput></screen>

    <para os="c">Now prepare Expect for compilation:</para>

<screen os="d"><userinput>./configure --prefix=/tools --with-tcl=/tools/lib \
    --with-tclinclude=/tools/include</userinput></screen>

    <variablelist os="e">
      <title>The meaning of the configure options:</title>

      <varlistentry os="e1">
        <term><parameter>--with-tcl=/tools/lib</parameter></term>
        <listitem>
          <para>This ensures that the configure script finds the Tcl
          installation in the temporary testsuite-tools location.</para>
        </listitem>
      </varlistentry>

      <varlistentry os="e2">
        <term><parameter>--with-tclinclude=/tools/include</parameter></term>
        <listitem>
          <para>This explicitly tells Expect where to find Tcl's internal headers.
           Using this option avoids conditions
          where <command>configure</command> fails because it cannot
          automatically discover the location of the Tcl source directory.</para>
        </listitem>
      </varlistentry>

    </variablelist>

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

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

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

<screen os="j"><userinput>make SCRIPTS="" install</userinput></screen>

    <variablelist os="k">
      <title>The meaning of the make parameter:</title>

      <varlistentry>
        <term><parameter>SCRIPTS=""</parameter></term>
        <listitem>
          <para>This prevents installation of the supplementary expect
          scripts, which are not needed.</para>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

  <sect2 id="contents-expect" role="content">
    <title>Contents of Expect</title>

    <segmentedlist>
      <segtitle>Installed program</segtitle>
      <segtitle>Installed library</segtitle>

      <seglistitem>
        <seg>expect</seg>
        <seg>libexpect-&expect-lib-version;.a</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="expect">
        <term><command>expect</command></term>
        <listitem>
          <para>Communicates with other interactive programs according
          to a script</para>
          <indexterm zone="ch-testsuite-tools-expect expect">
            <primary sortas="b-expect">expect</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libexpect">
        <term><filename class="libraryfile">libexpect-&expect-lib-version;.a</filename></term>
        <listitem>
          <para>Contains functions that allow Expect to be used as a Tcl
          extension or to be used directly from C or C++ (without Tcl)</para>
          <indexterm zone="ch-testsuite-tools-expect libexpect">
            <primary sortas="c-libexpect-&expect-lib-version;">libexpect-&expect-lib-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>