next | previous | forward | backward | up | top | index | toc | Macaulay2 website
Macaulay2Doc > getting started > reading the documentation > help

help -- view documentation nodes

Description

Various ways to get help:

  • help "Macaulay2" -- displays the base of the online documentation tree.
  • help X -- displays the online documentation for X.
  • help methods T -- displays help messages about the methods that take an object of class Tas input.
  • help methods res -- displays help messages about various uses the function res.
  • help methods symbol ** -- displays help messages about various uses and meanings of the operator **.
  • help methods (map, Module) -- displays help messages about various ways to use the function map and a module.
  • help methods (symbol **, T) -- displays help messages about various ways to use the operator ** and an object of class T.
  • help methods (X, Y) -- displays help messages about the methods usable with an object of class X and an object of class Y.
  • help apropos "hilbert" -- displays help messages about all functions whose name contains the string hilbert.
  • help about X -- displays documentation nodes from all installed packages whose keys contain X.
  • help about(X, Body => true) -- displays documentation nodes from all installed packages whose keys or contents contain X.

The help command is used to display online documentation, as in the following suggestions. Use viewHelp to display the corresponding documentation in your web browser.

  • help
  • help ideal
  • help(ideal, List)

Some other potential help topics:

  • help "monomial orderings"
  • help "Gr√∂bner bases"
  • help "multigraded polynomial rings"

See also

Ways to use help :

For the programmer

The object help is a command.