<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>getPackage(String) -- download a package from the repository</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_system_spfacilities.html">next</a> | <a href="_informing_spothers_spabout_spyour_sppackage.html">previous</a> | forward | <a href="_creating_spa_sppackage.html">backward</a> | <a href="_packages.html">up</a> | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<div><a href="index.html" title="">Macaulay2Doc</a> > <a href="___The_sp__Macaulay2_splanguage.html" title="">The Macaulay2 language</a> > <a href="_packages.html" title="">packages</a> > <a href="_get__Package_lp__String_rp.html" title="download a package from the repository">getPackage(String)</a></div>
<hr/>
<div><h1>getPackage(String) -- download a package from the repository</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><span>Function: <a href="_get__Package_lp__String_rp.html" title="download a package from the repository">getPackage</a></span></li>
<li><div class="single"><a href="_using_spfunctions_spwith_spoptional_spinputs.html">Optional inputs</a>:<ul><li><span><a href="_get__Package_lp__String_rp.html">Configuration => ...</a>, -- download a package from the repository</span></li>
<li><span><a href="_get__Package_lp__String_rp.html">CurrentVersion => ...</a>, -- download a package from the repository</span></li>
<li><span><a href="_get__Package_lp__String_rp.html">DebuggingMode => ...</a>, -- download a package from the repository</span></li>
<li><span><a href="_get__Package_lp__String_rp.html">Repository => ...</a>, -- download a package from the repository</span></li>
<li><span><a href="_get__Package_lp__String_rp.html">UserMode => ...</a>, -- download a package from the repository</span></li>
<li><span><a href="_get__Package_lp__String_rp.html">Version => ...</a>, -- download a package from the repository</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><div><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>getPackage pkgname</tt></div>
</dd></dl>
</div>
</li>
<li>Inputs:<ul><li><span><tt>pkgname</tt>, <span>a <a href="___String.html">string</a></span>, the name of a package</span></li>
<li><span><tt>Version => </tt><span><span>a <a href="___String.html">string</a></span>, <span>default value null</span>, the version to download, instead of the most recent version</span></span></li>
<li><span><tt>CurrentVersion => </tt><span><span>a <a href="___String.html">string</a></span>, <span>default value null</span>, the version currently installed</span></span></li>
<li><span><tt>Repository => </tt><span><span>a <a href="___String.html">string</a></span>, <span>default value http://www.math.uiuc.edu/Macaulay2/Packages/</span>, the URL of the repository</span></span></li>
<li><span><tt>DebuggingMode => </tt><span><span>a <a href="___Boolean.html">Boolean value</a></span>, <span>default value false</span>, the debugging mode to be passed to <a href="_install__Package.html" title="load and install a package and its documentation ">installPackage</a></span></span></li>
<li><span><tt>UserMode => </tt><span><span>default value null</span>, the user mode to be passed to <a href="_install__Package.html" title="load and install a package and its documentation ">installPackage</a></span></span></li>
<li><span><tt>Configuration => </tt><span><span>a <a href="___List.html">list</a></span>, <span>default value {}</span>, the list of configuration values to be passed to <a href="_load__Package.html" title="load a package">loadPackage</a></span></span></li>
</ul>
</li>
<li>Consequences:<ul><li>the most recent version of the package is downloaded from the repository and installed, unless it's not newer than the version currently installed (according to the value of the CurrentVersion option)</li>
</ul>
</li>
</ul>
</div>
<div><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>getPackage()</tt></div>
</dd></dl>
</div>
</li>
<li>Inputs:<ul><li><span><tt>Repository => </tt><span><span>a <a href="___String.html">string</a></span>, <span>default value http://www.math.uiuc.edu/Macaulay2/Packages/</span>, the URL of the repository</span></span></li>
</ul>
</li>
<li>Outputs:<ul><li><span><span>a <a href="___List.html">list</a></span>, a list of names of available packages from the repository</span></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_install__Package.html" title="load and install a package and its documentation ">installPackage</a> -- load and install a package and its documentation </span></li>
</ul>
</div>
</div>
</body>
</html>
