Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 91213ddcfbe7f54821d42c2d9e091326 > files > 2584

gap-system-packages-4.4.12-5mdv2010.0.i586.rpm

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GAP (ResClasses) - Chapter 4: Installation and auxiliary functions</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
</head>
<body>


<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<div class="chlinkprevnexttop">&nbsp;<a href="chap0.html">Top of Book</a>&nbsp;  &nbsp;<a href="chap3.html">Previous Chapter</a>&nbsp;  &nbsp;<a href="chapBib.html">Next Chapter</a>&nbsp;  </div>

<p><a id="X859F6BF88754E5CC" name="X859F6BF88754E5CC"></a></p>
<div class="ChapSects"><a href="chap4.html#X859F6BF88754E5CC">4. <span class="Heading">Installation and auxiliary functions</span></a>
<div class="ContSect"><span class="nocss">&nbsp;</span><a href="chap4.html#X85A08CF187A6D986">4.1 <span class="Heading">Requirements</span></a>
</div>
<div class="ContSect"><span class="nocss">&nbsp;</span><a href="chap4.html#X8360C04082558A12">4.2 <span class="Heading">Installation</span></a>
</div>
<div class="ContSect"><span class="nocss">&nbsp;</span><a href="chap4.html#X8667D5027AC3DE8E">4.3 <span class="Heading">The testing routine</span></a>
<span class="ContSS"><br /><span class="nocss">&nbsp;&nbsp;</span><a href="chap4.html#X8733F00082901C2C">4.3-1 ResClassesTest</a></span>
</div>
<div class="ContSect"><span class="nocss">&nbsp;</span><a href="chap4.html#X854E65D281B80D3B">4.4 <span class="Heading">Building the manual</span></a>
<span class="ContSS"><br /><span class="nocss">&nbsp;&nbsp;</span><a href="chap4.html#X7B4E650D828174F7">4.4-1 ResClassesBuildManual</a></span>
</div>
<div class="ContSect"><span class="nocss">&nbsp;</span><a href="chap4.html#X864279AC8500FD3B">4.5 <span class="Heading">SendEmail and EmailLogFile</span></a>
<span class="ContSS"><br /><span class="nocss">&nbsp;&nbsp;</span><a href="chap4.html#X7F27919085001EA8">4.5-1 SendEmail</a></span>
<span class="ContSS"><br /><span class="nocss">&nbsp;&nbsp;</span><a href="chap4.html#X8000E5CF7DF4339C">4.5-2 EmailLogFile</a></span>
</div>
</div>

<h3>4. <span class="Heading">Installation and auxiliary functions</span></h3>

<p><a id="X85A08CF187A6D986" name="X85A08CF187A6D986"></a></p>

<h4>4.1 <span class="Heading">Requirements</span></h4>

<p>The <strong class="pkg">ResClasses</strong> package needs at least <strong class="pkg">GAP</strong> 4.4.7 and <strong class="pkg">GAPDoc</strong> 0.99999 <a href="chapBib.html#biBGAPDoc">[LN07]</a>. It can be used under UNIX, under Windows and on the MacIntosh. <strong class="pkg">ResClasses</strong> is completely written in the <strong class="pkg">GAP</strong> language and does neither contain nor require external binaries.</p>

<p><a id="X8360C04082558A12" name="X8360C04082558A12"></a></p>

<h4>4.2 <span class="Heading">Installation</span></h4>

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

<p><a id="X8667D5027AC3DE8E" name="X8667D5027AC3DE8E"></a></p>

<h4>4.3 <span class="Heading">The testing routine</span></h4>

<p><a id="X8733F00082901C2C" name="X8733F00082901C2C"></a></p>

<h5>4.3-1 ResClassesTest</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&gt; ResClassesTest</code>( <var class="Arg"></var> )</td><td class="tdright">( function )</td></tr></table></div>
<p><b>Returns: </b>Nothing.</p>

<p>Performs tests of the <strong class="pkg">ResClasses</strong> package. Errors, i.e. differences to the correct results of the test computations, are reported. The processed test files are in the directory <code class="file">pkg/resclasses/tst</code>.</p>

<p><a id="X854E65D281B80D3B" name="X854E65D281B80D3B"></a></p>

<h4>4.4 <span class="Heading">Building the manual</span></h4>

<p><a id="X7B4E650D828174F7" name="X7B4E650D828174F7"></a></p>

<h5>4.4-1 ResClassesBuildManual</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&gt; ResClassesBuildManual</code>( <var class="Arg"></var> )</td><td class="tdright">( function )</td></tr></table></div>
<p><b>Returns: </b>Nothing.</p>

<p>This function is a development tool which builds the manual of the <strong class="pkg">ResClasses</strong> package in the file formats LaTeX, PDF, HTML and ASCII text. This is accomplished using the <strong class="pkg">GAPDoc</strong> package by Frank Lübeck and Max Neunhöffer. Building the manual is possible only on UNIX systems and requires PDFLaTeX. As all files generated by this function are included in the distribution file anyway, users will not need it.</p>

<p><a id="X864279AC8500FD3B" name="X864279AC8500FD3B"></a></p>

<h4>4.5 <span class="Heading">SendEmail and EmailLogFile</span></h4>

<p><a id="X7F27919085001EA8" name="X7F27919085001EA8"></a></p>

<h5>4.5-1 SendEmail</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&gt; SendEmail</code>( <var class="Arg">sendto, copyto, subject, text</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p><b>Returns: </b>Zero if everything worked correctly, and a system error number otherwise.</p>

<p>Sends an e-mail with subject <var class="Arg">subject</var> and body <var class="Arg">text</var> to the addresses in the list <var class="Arg">sendto</var>, and copies it to those in the list <var class="Arg">copyto</var>. The first two arguments must be lists of strings, and the latter two must be strings.</p>

<p>As most system-related functions, <code class="code">SendEmail</code> works only under UNIX. Further, the computer must of course be connected to the internet.</p>

<p><a id="X8000E5CF7DF4339C" name="X8000E5CF7DF4339C"></a></p>

<h5>4.5-2 EmailLogFile</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&gt; EmailLogFile</code>( <var class="Arg">addresses</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p><b>Returns: </b>Zero if everything worked correctly, and a system error number otherwise.</p>

<p>Sends the current log file by e-mail to <var class="Arg">addresses</var>, if <strong class="pkg">GAP</strong> is in logging mode and one is working under UNIX, and does nothing otherwise. The argument <var class="Arg">addresses</var> must be either a list of e-mail addresses or a single e-mail address. Long log files are abbreviated, i.e. if the log file is larger than 64KB, then any output is truncated at 1KB, and if the log file is still longer than 64KB afterwards, it is truncated at 64KB.</p>


<div class="chlinkprevnextbot">&nbsp;<a href="chap0.html">Top of Book</a>&nbsp;  &nbsp;<a href="chap3.html">Previous Chapter</a>&nbsp;  &nbsp;<a href="chapBib.html">Next Chapter</a>&nbsp;  </div>


<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<hr />
<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>