infoHelpinfoHelp XSome example uses:
infoHelp |
-- open the top of the online documentation tree |
infoHelp "Macaulay2" |
-- open the top of the online documentation tree |
infoHelp "matrices" |
-- open an overview of matrices in Macaulay2 |
infoHelp X |
-- open the documentation node whose key is X |
infoHelp ideal |
-- documentation for the function ideal and ways to use it |
infoHelp(ideal, List) |
-- documentation for the method ideal(List) |
infoHelp[gb, DegreeLimit] |
-- documentation for the optional argument gb(...,DegreeLimit=>...) |
infoHelp(symbol **, Ring, Ring) |
-- documentation for the method Ring ** Ring |
While in the info program, there are many ways to navigate and search. Besides the arrow keys to move around on the page, here is a list of the most useful key strokes:
| ? | -- information about all of the possible keystrokes |
| q | -- quit info, return to Macaulay2 |
| n | -- go to the next documentation node |
| p | -- go to the previous node |
| m | -- follow the menu link |
| r | -- follow a cross-reference |
| l | -- go to the last node visited |
The help command allows other possible arguments, such as help methods ideal, but infoHelp requires that the argument refer to only one documentation page.
If you read the info form of the documentation in Emacs, we recommend configuring the value of the Emacs variable Info-hide-note-references to hide in order to prevent Emacs from inserting a superfluous See or see in front of the hyperlinks. This is done automatically for you by running setup or setupEmacs.