<!-- #################################################################### -->
<!-- ##                                                                ## -->
<!-- ##  resclaux.xml      ResClasses documentation       Stefan Kohl  ## -->
<!-- ##                                                                ## -->
<!-- ##  $Id: resclaux.xml,v 1.17 2006/05/29 13:38:55 stefan Exp $     ## -->
<!-- ##                                                                ## -->
<!-- #################################################################### -->

<Chapter Label="ch:InstallationAndAuxiliaryFunctions">
<Heading>Installation and auxiliary functions</Heading>

<!-- #################################################################### -->

<Section Label="sec:Requirements">
<Heading>Requirements</Heading>

The &ResClasses; package needs at least &GAP;&nbsp;4.4.7 and
&GAPDoc;&nbsp;0.999&nbsp;<Cite Key="GAPDoc"/>.
It can be used under UNIX, under Windows and on the MacIntosh.
&ResClasses; is completely written in the &GAP; language and does
neither contain nor require external binaries.

</Section>

<!-- #################################################################### -->
<Section Label="sec:Installation">

<Heading>Installation</Heading>

Like any other &GAP; package, &ResClasses; must be installed in the
<F>pkg</F> subdirectory of the &GAP; distribution. This is accomplished by
extracting the distribution file in this directory. By default,
the package &ResClasses; is autoloaded. If you have switched autoloading
of packages off, you can load &ResClasses; via
<C>LoadPackage( "resclasses" );</C>.

</Section>

<!-- #################################################################### -->

<Section Label="sec:TheTestingRoutine">
<Heading>The testing routine</Heading>

<ManSection>
  <Func Name="ResClassesTest" Arg=""/>
  <Returns> Nothing. </Returns>
  <Description>
    Performs tests of the &ResClasses; package.
    Errors, i.e. differences to the correct results of the test computations,
    are reported. The processed test files are in the directory
    <F>pkg/resclasses/tst</F>.
  </Description>
</ManSection>

</Section>

<!-- #################################################################### -->

<Section Label="sec:BuildingTheManual">
<Heading>Building the manual</Heading>

<ManSection>
  <Func Name="ResClassesBuildManual" Arg=""/>
  <Returns> Nothing. </Returns>
  <Description>
    This function is a development tool which builds the manual of the
    &ResClasses; package in the file formats &LaTeX;, DVI, Postscript, PDF,
    HTML and ASCII text.
    This is accomplished using the &GAPDoc; package by Frank Lübeck and
    Max Neunhöffer. Building the manual is possible only on UNIX systems
    and requires &LaTeX;, PDF&LaTeX; and <Package>dvips</Package>.
    As all files generated by this function are included in the distribution
    file anyway, users will not need it.
  </Description>
</ManSection>

</Section>

<!-- #################################################################### -->

</Chapter>

<!-- #################################################################### -->
