source: general/prog/dejagnu.xml@ d3970e1

<?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 dejagnu-download-http "http://freshmeat.net/redir/dejagnu/12564/url_tgz/dejagnu-&dejagnu-version;.tar.gz"> -->
  <!ENTITY dejagnu-download-http " ">
  <!ENTITY dejagnu-download-ftp  "ftp://ftp.gnu.org/pub/gnu/dejagnu/dejagnu-&dejagnu-version;.tar.gz">
  <!ENTITY dejagnu-md5sum        "3df1cbca885e751e22d3ebd1ac64dc3c">
  <!ENTITY dejagnu-size          "568 KB">
  <!ENTITY dejagnu-buildsize     "4.5 MB">
  <!ENTITY dejagnu-time          "less than 0.1 SBU">
]>

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

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

  <title>DejaGnu-&dejagnu-version;</title>

  <indexterm zone="dejagnu">
    <primary sortas="a-DejaGnu">DejaGnu</primary>
  </indexterm>

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

    <para>
      <application>DejaGnu</application> is a framework for running test
      suites on GNU tools. It is written in <command>expect</command>, which
      uses <application>Tcl</application> (Tool command language). It was installed
      by LFS in the temporary <filename class="directory">/tools</filename>
      directory.  These instructions install it permanently.
    </para>

    &lfs72_checked;

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

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

    <bridgehead renderas="sect4">Required (Run-time Only)</bridgehead>
    <para role="required">
      <xref linkend="expect"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docbook-utils"/> and
      <ulink url="http://sourceforge.net/projects/docbook2x/">docbook2X</ulink>
      (both looked for by the <command>configure</command> script but not used
      in the build)
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
makeinfo --html --no-split -o doc/dejagnu.html doc/dejagnu.texi &amp;&amp;
makeinfo --plaintext       -o doc/dejagnu.txt  doc/dejagnu.texi</userinput></screen>

    <para>
      HTML and text documentation was created in the previous step. There
      are different ways to create additional forms of documentation, if desired.
      If you have <xref linkend="texlive"/> installed, create PDF and Postscript
      docs in the <filename class="directory">doc</filename> directory by issuing
      <command>make pdf ps</command>. If you have <xref linkend="docbook-utils"/>
      installed, create PDF and Postscript docs in the top-level directory
      by issuing <command>make dejagnu.{pdf,ps}</command>.
    </para>

    <para>
      To test the results, issue <command>make check</command>.
    </para>

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

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/dejagnu-&dejagnu-version; &amp;&amp;
install -v -m644    doc/dejagnu.{html,txt} \
                    /usr/share/doc/dejagnu-&dejagnu-version;</userinput></screen>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Scripts</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>runtest</seg>
        <seg>None</seg>
        <seg>There are numerous <application>Expect</application> scripts installed in
        the <filename class='directory'>/usr/share/dejagnu</filename> hierarchy.</seg>
        <seg>/usr/share/dejagnu</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="runtest">
        <term><command>runtest</command></term>
        <listitem>
          <para>
            is the <application>DejaGnu</application> test driver program. It is
            used to control what tests to run, and variations on how to run them.
          </para>
          <indexterm zone="dejagnu runtest">
            <primary sortas="b-runtest">runtest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>