Macaulay2 » Documentation
Packages » Macaulay2Doc » reading the documentation » help
next | previous | forward | backward | up | index | toc

help -- view documentation nodes

Description

Various ways to get help:

help -- display the initial help
help "Macaulay2" -- display the top of the documentation tree
help "matrices" -- display an overview of matrices in Macaulay2
help X -- display the documentation node whose key is X
help res -- documentation for the function res and ways to use it
help(res, Module) -- documentation for the method resolution(Module)
help Module -- documentation for the type Module and methods that take one as input
help symbol ** -- documentation for the operator ** and its various uses and meanings
help(symbol **, Ring, Ring) -- documentation for the method Ring ** Ring
help[gb, DegreeLimit] -- documentation for the optional argument gb(...,DegreeLimit=>...)
help methods(map, Module) -- documentation for various ways to use the function map and a module
help methods(symbol **, T) -- documentation for various ways to use the operator ** and an object of class T
help methods(X, Y) -- documentation for the methods that take an object of class X and an object of class Y
help apropos "hilbert" -- documentation about all functions whose name contains the string hilbert
help about X -- documentation nodes from all installed packages whose keys contain X
help about(X, Body => true) -- 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.

help
help ideal
help(ideal, List)

Some other potential help topics:

help "monomial orderings"
help "Gröbner bases"
help "graded and multigraded polynomial rings"

Use viewHelp to display the corresponding documentation in your web browser.

See also

Ways to use help:

  • "help"
  • help(ZZ) -- see headlines -- display a table of documentation headlines
  • help(Array)
  • help(DocumentTag)
  • help(List)
  • help(Sequence)
  • help(String)
  • help(Symbol)
  • help(Thing)

For the programmer

The object help is a command.


The source of this document is in Macaulay2Doc/functions/help-doc.m2:69:0.