viewHelp -- view online documentation in a web browser
Synopsis
Usage:
viewHelp
viewHelp X
Inputs:
X, a thing, a descriptor for a documentation node (see below for examples)
Consequences:
The given documentation page is displayed in your default web browser, as determined by either open on macOS or xdg-open on Linux distributions. As backup for when neither open nor xdg-open is available, the environmental variable WWWBROWSER or firefox is used.If no argument is given to viewHelp then the top page of your local html documentation is displayed.
Description
Some example uses:
viewHelp -- top of local copy of the documentation, including installed packages
viewHelp "Macaulay2" -- top of Macaulay2 doc
viewHelp ideal -- online doc for the 'ideal' function
viewHelp "matrices" -- overview of matrices in Macaulay2
viewHelp (ideal, List) -- online doc for ideal(List) method
viewHelp (diff, Matrix, Matrix) -- online doc for the diff function taking two matrices as arguments
viewHelp [gb, DegreeLimit] -- view doc for the optional argument DegreeLimit to gb function
viewHelp (symbol**, Matrix, Matrix) -- view doc for Matrix**Matrix
Caveat
The help command allows other possible arguments, such as help methods ideal, but for viewHelp the argument X must refer to only one web page.