<?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>export -- package item: export functions</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_export__Mutable.html">next</a> | <a href="_new__Package_lp__String_rp.html">previous</a> | <a href="_export__Mutable.html">forward</a> | <a href="_new__Package_lp__String_rp.html">backward</a> | <a href="_creating_spa_sppackage.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="_creating_spa_sppackage.html" title="">creating a package</a> > <a href="_export.html" title="package item: export functions">export</a></div>
<hr/>
<div><h1>export -- package item: export functions</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>export {symbol1,symbol2,...}</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>{symbol1,symbol2,...}</tt>, a list of symbols, strings, or options</span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li>The symbols in the list, which should refer to functions or other symbols defined in the package, are made available to the user of the package, and are marked non-mutable. The strings are converted to symbols with those names in the dictionary of the package. An option of the form <tt>"nam" => sym</tt> creates a symbol with the name <tt>"nam"</tt> that is a synonym of the symbol<tt>"nam" => sym</tt>.</li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span><span>a <a href="___List.html">list</a></span>, the list of exported symbols</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>A package can contain the code for many functions, only some of which should be made visible to the user. The function <tt>export</tt> allows one to specify which symbols are to be made visible. For an example see <a href="_an_spexample_spof_spa_sppackage.html" title="">an example of a package</a>.<p>Use <a href="_export__Mutable.html" title="package item: export writable variables">exportMutable</a> to export symbols whose values the user is permitted to modify.</p>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_debug.html" title="open private dictionary of a package">debug</a> -- open private dictionary of a package</span></li>
</ul>
</div>
<div class="waystouse"><h2>Ways to use <tt>export</tt> :</h2>
<ul><li>export(List)</li>
<li>export(String)</li>
<li>export(Symbol)</li>
</ul>
</div>
</div>
</body>
</html>
