<?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>Usage -- shows the usage of a function</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_use.html">next</a> | <a href="___U__R__L.html">previous</a> | <a href="_use.html">forward</a> | <a href="___U__R__L.html">backward</a> | up | <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>
<hr/>
<div><h1>Usage -- shows the usage of a function</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>document { ... , Usage => "usage", ... }</tt></div>
</dd></dl>
</div>
</li>
<li><span>Function: <a href="_document.html" title="package item: documentation node">document</a></span></li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>The <tt>Usage</tt> entry should give a formal example showing the usage of the function. The variables used in this formal example should be the ones used in the <a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html" title="inputs for a function">Inputs</a> and <a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html" title="outputs for a function">Outputs</a> sections of the documentation. Here is the code for the <tt>Usage</tt> entry of the method <a href="_matrix_lp__List_rp.html" title="create a matrix from a doubly-nested list of ring elements or matrices">matrix(List)</a>:<pre>Usage => "matrix v"</pre>
Here is the code for the <tt>Usage</tt> entry of the method <a href="_resolution_lp__Module_rp.html" title="compute a projective resolution of a module">resolution(Module)</a>:<pre>Usage => "resolution M\nres M"</pre>
<p>This option also can be used within a <a href="___S__Y__N__O__P__S__I__S.html" title="">SYNOPSIS</a> section.</p>
</div>
</div>
<div class="single"><h2>Functions with optional argument named Usage :</h2>
<ul><li><span>SYNOPSIS(..., Usage => ...), see <span><a href="___S__Y__N__O__P__S__I__S.html" title="">SYNOPSIS</a></span></span></li>
<li>document(..., Usage => ...)</li>
</ul>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_document.html" title="package item: documentation node">document</a> -- package item: documentation node</span></li>
<li><span><a href="_document_lp..._cm_sp__Inputs_sp_eq_gt_sp..._rp.html" title="inputs for a function">Inputs</a> -- inputs for a function</span></li>
<li><span><a href="_document_lp..._cm_sp__Outputs_sp_eq_gt_sp..._rp.html" title="outputs for a function">Outputs</a> -- outputs for a function</span></li>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="___Usage.html" title="shows the usage of a function">Usage</a> is <span>a <a href="___Symbol.html">symbol</a></span>.</p>
</div>
</div>
</body>
</html>
