<?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>apropos(String) -- symbols matching a pattern</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_argument.html">next</a> | <a href="_apply__Table.html">previous</a> | <a href="_argument.html">forward</a> | <a href="_apply__Table.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>apropos(String) -- symbols matching a pattern</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>apropos pat</tt></div>
</dd></dl>
</div>
</li>
<li><span>Function: <a href="_apropos_lp__String_rp.html" title="symbols matching a pattern">apropos</a></span></li>
<li><div class="single">Inputs:<ul><li><span><tt>pat</tt>, <span>a <a href="___String.html">string</a></span>, a regular expression pattern to match</span></li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span><span>a <a href="___List.html">list</a></span>, of global symbols in Macaulay2 matching the given pattern</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>In the simplest case, the list of symbols containing the given string is returned.<table class="examples"><tr><td><pre>i1 : apropos "atrix"
o1 = {ChangeMatrix, compactMatrixForm, diagonalMatrix, fillMatrix,
------------------------------------------------------------------------
genericMatrix, genericSkewMatrix, genericSymmetricMatrix,
------------------------------------------------------------------------
getChangeMatrix, Matrix, matrix, MatrixExpression, MinimalMatrix,
------------------------------------------------------------------------
MutableMatrix, mutableMatrix, randomMutableMatrix, submatrix,
------------------------------------------------------------------------
submatrix', sylvesterMatrix, SyzygyMatrix}
o1 : List</pre>
</td></tr>
</table>
<a href="_regular_spexpressions.html">Regular expressions</a> allow for more complicated requests. For example, to find all functions that start with <tt>mat</tt> or <tt>Mat</tt>:<table class="examples"><tr><td><pre>i2 : apropos "^[mM]at"
o2 = {match, mathML, Matrix, matrix, MatrixExpression}
o2 : List</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_find__Synonyms_lp__Symbol_rp.html" title="find synonyms of symbols">findSynonyms</a> -- find synonyms of symbols</span></li>
<li><span><a href="_help.html" title="help command">help</a> -- help command</span></li>
<li><span><a href="_examples.html" title="list the examples in documentation">examples</a> -- list the examples in documentation</span></li>
<li><span><a href="_view__Help.html" title="view online doc with a web browser">viewHelp</a> -- view online doc with a web browser</span></li>
<li><span><a href="_info__Help.html" title="view online doc with info">infoHelp</a> -- view online doc with info</span></li>
<li><span><a href="_reading_spthe_spdocumentation.html" title="">reading the documentation</a></span></li>
<li><span><a href="_regular_spexpressions.html" title="">regular expressions</a></span></li>
</ul>
</div>
</div>
</body>
</html>
