<?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>viewHelp -- view online doc with a web browser</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___Virtual__Tally.html">next</a> | <a href="___Vertical__Space.html">previous</a> | <a href="___Virtual__Tally.html">forward</a> | <a href="___Vertical__Space.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>viewHelp -- view online doc with a web browser</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>viewHelp</tt><br/><tt>viewHelp s</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>s</tt>, a descriptor for a documentation node (see below for examples)</span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li>The given documentation page is displayed in your default web browser. If the browser is not running, it is started. If no argument is given to <tt>viewHelp</tt>then the top page of your local html documentation is displayed.</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div>Some example uses:<ul><li><tt>viewHelp</tt> -- top of local copy of the documentation, including installed packages</li>
<li><tt>viewHelp "Macaulay2"</tt> -- top of Macaulay2 doc</li>
<li><tt>viewHelp ideal</tt> -- online doc for the 'ideal' function</li>
<li><tt>viewHelp "matrices"</tt> -- overview of matrices in Macaulay2</li>
<li><tt>viewHelp (ideal,List)</tt> -- online doc for ideal(List) method</li>
<li><tt>viewHelp (diff,Matrix,Matrix)</tt> -- online doc for the diff function taking two matrices as arguments</li>
<li><tt>viewHelp [gb,DegreeLimit]</tt> -- view doc for the optional argument DegreeLimit to gb function</li>
<li><tt>viewHelp (symbol**,Matrix,Matrix)</tt> -- view doc for Matrix**Matrix</li>
</ul>
</div>
</div>
<div class="single"><h2>Caveat</h2>
<div>The <a href="_help.html" title="help command">help</a> command allows other possible arguments, such as <tt>help methods ideal</tt>, but for <tt>viewHelp</tt> the argument <tt>s</tt> must refer to ony one web page.</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_apropos_lp__String_rp.html" title="symbols matching a pattern">apropos</a> -- symbols matching a pattern</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="_help.html" title="help command">help</a> -- help command</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>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="_view__Help.html" title="view online doc with a web browser">viewHelp</a> is <span>a <a href="___Command.html">command</a></span>.</p>
</div>
</div>
</body>
</html>
