source: general/prog/dejagnu.xml@ 2c1ff38

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

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY dejagnu-download-http "http://freshmeat.net/redir/dejagnu/12564/url_tgz/dejagnu-&dejagnu-version;.tar.gz">
  <!ENTITY dejagnu-download-ftp  "ftp://ftp.gnu.org/pub/gnu/dejagnu/dejagnu-&dejagnu-version;.tar.gz">
  <!ENTITY dejagnu-md5sum        "053f18fd5d00873de365413cab17a666">
  <!ENTITY dejagnu-size          "1.08 MB">
  <!ENTITY dejagnu-buildsize     "8.5 MB">
  <!ENTITY dejagnu-time          ".04 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">dejagnu-&dejagnu-version;.tar</keyword>
      <keyword role="ftpdir">dejagnu</keyword>
    </keywordset>
  </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).</para>

    <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"/></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;
make</userinput></screen>

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

<screen role="root"><userinput>make install &amp;&amp;
make install-doc</userinput></screen>

    <para>To test the installation, issue <command>make check</command> as
    an unprivileged user.</para>

  </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>