help functions

help functions

Online Macaulay 2 documentation is stored in hypertext form.

Functions for accessing the documentation:

apropos -- symbols matching a pattern

briefDocumentation -- get brief documentation

documentation -- get documentation, unformatted

examples -- list the examples in documentation

help -- get help

topicList -- list of help topics

topics -- display available help topics

How to write documentation yourself:

document -- install documentation

Output formatting routines:

html -- convert hypertext to html format

mathML -- convert to MathML format

tex -- convert to TeX

text -- convert hypertext to text

Some internals:

See also:

Reading the Documentation