source: general/prog/expect.xml@ 518538f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY expect-download-http "http://expect.nist.gov/old/expect-&expect-version;.tar.gz">
  <!ENTITY expect-download-ftp  " ">
  <!ENTITY expect-md5sum        "fea346fac6aaf74b0851f2441f478571">
  <!ENTITY expect-size          "525 KB">
  <!ENTITY expect-buildsize     "4.8 MB">
  <!ENTITY expect-time          "0.1 SBU">
]>

<sect1 id="expect" xreflabel="Expect-&expect-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="expect.html"?>
<title>Expect-&expect-version;</title>

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

<para>The <application>Expect</application> package contains tools for 
automating interactive applications such as <command>telnet</command>, 
<command>ftp</command>, <command>passwd</command>, <command>fsck</command>, 
<command>rlogin</command>, <command>tip</command>, etc. 
<application>Expect</application> is also useful for testing these same 
applications as well as easing all sorts of tasks that are prohibitively 
difficult with anything else.</para>

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

<sect3><title>Additional downloads</title>
<itemizedlist spacing="compact">
<listitem><para>Required Patch: <ulink
url="&patch-root;/expect-&expect-version;-spawn-1.patch"/></para>
</listitem></itemizedlist>
</sect3>

<sect3><title><application>Expect</application> dependencies</title>

<sect4><title>Required</title>
<para><xref linkend="tcl"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="tk"/></para>
</sect4>
</sect3>

</sect2>

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

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

<screen><userinput><command>patch -Np1 -i ../expect-&expect-version;-spawn-1.patch &amp;&amp;
./configure --prefix=/usr --with-tcl=/usr/lib \
    --with-tclinclude=/usr/include/tcl8.4 --enable-shared &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
ln -sf ../libexpect5.42.a /usr/lib/expect5.42</command></userinput></screen>

</sect2>

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

<para><parameter>--enable-shared</parameter>: This option enables building the 
shared library.</para>

<para><option>--with-tk=/usr/lib</option>: Use this option to link in the 
<application>Tk</application> library.</para>

<para><command>ln -sf ../libexpect5.42.a /usr/lib/expect5.42</command>: This 
command creates a required link to the static library.</para>

</sect2>

<sect2>
<title>Configuring <application>Expect</application></title>

<sect3><title>Config files</title>
<para><filename>$exp_library/expect.rc</filename> and 
<filename>~/.expect.rc</filename></para>
</sect3>

<sect3><title>Configuration Information</title>

<para>Reference the <command>expect</command> man page for information about
utilizing the <filename>expect.rc</filename> configuration files. Additionally,
many of the tools contained in the <application>Expect</application> package
will use their own configuration files. Reference the respective man page, or
examine the script directly for configuration file information.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Expect</application> package contains the 
<filename class='libraryfile'>libexpect</filename> libraries, 
<command>autoexpect</command>, 
<command>autopasswd</command>, 
<command>cryptdir</command>, 
<command>decryptdir</command>, 
<command>dislocate</command>, 
<command>expect</command>, 
<command>ftp-rfc</command>, 
<command>kibitz</command>, 
<command>lpunlock</command>, 
<command>mkpasswd</command>, 
<command>passmass</command>, 
<command>rftp</command>, 
<command>rlogin-cwd</command>, 
<command>timed-read</command>, 
<command>timed-run</command>, 
<command>unbuffer</command>, 
<command>weather</command> and optionally 
(if <application>expect</application> was linked against 
<application>Tk</application>), 
<command>expectk</command>, 
<command>multixterm</command>, 
<command>tknewsbiff</command>, 
<command>tkpasswd</command>, 
<command>xkibitz</command> and 
<command>xpstat</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>autoexpect</title>
<para><command>autoexpect</command> generates an 
<application>Expect</application> script from watching a session.</para>
</sect3>

<sect3><title>autopasswd</title>
<para><command>autopasswd</command> is a wrapper to make passwd(1) be 
non-interactive.</para>
</sect3>

<sect3><title>cryptdir</title>
<para><command>cryptdir</command> encrypts all files in a directory.</para>
</sect3>

<sect3><title>decryptdir</title>
<para><command>decryptdir</command> decrypts all files in a directory.</para>
</sect3>

<sect3><title>dislocate</title>
<para><command>dislocate</command> allows processes to be disconnected and 
reconnected to a terminal.</para>
</sect3>

<sect3><title>expect</title>
<para><command>expect</command> is a program that <quote>talks</quote> to 
other interactive programs according to a script.</para>
</sect3>

<sect3><title>ftp-rfc</title>
<para><command>ftp-rfc</command> retrieves an rfc (or the index) from 
uunet.</para>
</sect3>

<sect3><title>kibitz</title>
<para><command>kibitz</command> allows two (or more) people to interact with 
one shell (or any arbitrary program).</para>
</sect3>

<sect3><title>lpunlock</title>
<para><command>lpunlock</command> unhangs a printer which claims it is 
<quote>waiting for lock</quote>.</para>
</sect3>

<sect3><title>mkpasswd</title>
<para><command>mkpasswd</command> generates passwords and can apply them 
automatically to users.</para>
</sect3>

<sect3><title>passmass</title>
<para><command>passmass</command> changes a password on multiple 
machines.</para>
</sect3>

<sect3><title>rftp</title>
<para><command>rftp</command> is much like <command>ftp</command> except 
it uses '~g' and '~p' instead of 'mget' and 'mput'.</para>
</sect3>

<sect3><title>rlogin-cwd</title>
<para><command>rlogin-cwd</command> is <command>rlogin</command> except 
it uses the local current directory as the current working directory on the 
remote machine.</para>
</sect3>

<sect3><title>timed-read</title>
<para><command>timed-read</command> reads a complete line from stdin
and aborts after a given number of seconds.</para>
</sect3>

<sect3><title>timed-run</title>
<para><command>timed-run</command> runs a program for a given amount of 
time.</para>
</sect3>

<sect3><title>unbuffer</title>
<para><command>unbuffer</command> disables the output buffering that occurs 
when program output is redirected.</para>
</sect3>

<sect3><title>weather</title>
<para><command>weather</command> retrieves a weather report (courtesy 
University of Michigan) for a given city or geographical area.</para>
</sect3>

<sect3><title>expectk</title>
<para><command>expectk</command> is a combination of 
<application>Expect</application> with <application>Tk</application> and should 
run any <command>wish</command> or <application>Expect</application> 
script.</para>
</sect3>

<sect3><title>multixterm</title>
<para><command>multixterm</command> creates multiple <command>xterm</command>s 
that can be driven together or separately.</para>
</sect3>

<sect3><title>tknewsbiff</title>
<para><command>tknewsbiff</command> pops up a window when there is unread news 
in your favorite newsgroups and removes the window after you've read the 
news.</para>
</sect3>

<sect3><title>tkpasswd</title>
<para><command>tkpasswd</command> is a script to change passwords using 
<command>expectk</command>.</para>
</sect3>

<sect3><title>xkibitz</title>
<para><command>xkibitz</command> allows users in separate 
<command>xterm</command>s to share one shell (or any program that runs in an 
<command>xterm</command>).</para>
</sect3>

<sect3><title>xpstat</title>
<para><command>xpstat</command> is a script that acts as a front-end for 
<command>xpilot</command>.</para>
</sect3>

</sect2>

</sect1>