User manual

Chapter 8: Reading help files 45
‘R’ REQUIRED ARGUMENTS:
‘r’ REFERENCES:
‘s’ SEE ALSO:
‘S’ SIDE EFFECTS:
‘u’ USAGE:
‘v’ VALUE:
‘<’ Jumps to beginning of file
‘>’ Jumps to end of file
‘?’ Pops up a help buffer with a list of the defined section motion keys.
Evaluation:
l ess-eval-line-and-step Evaluates the current line in the ESS process, and
moves to the next line. Useful for running examples in help files.
r ess-eval-region Send the contents of the current region to the ESS process.
Useful for running examples in help files.
Quit commands:
q ess-help-quit Return to previously selected buffer, and bury the help buffer.
k kill-buffer Return to previously selected buffer, and kills the help buffer.
x ess-kill-buffer-and-go Return to the ESS process, killing this help buffer.
Miscellaneous:
i ess-display-index Prompt for a package and display it’s help index.
v ess-display-vignettes Display all available vignettes.
w ess-display-help-in-browser Display current help page with the web
browser.
/ isearch-forward Same as C-s.
In addition, all of the ESS commands available in the edit buffers are also available in S
help mode (see Section 7.1 [Edit buffer], page 37). Of course, the usual (non-editing) Emacs
commands are available, and for convenience the digits and - act as prefix arguments.
If a help buffer already exists for an object for which help is requested, that buffer is
popped to immediately; the ESS process is not consulted at all. If the contents of the help
file have changed, you either need to kill the help buffer first, or pass a prefix argument
(with C-u) to ess-display-help-on-object.
Help buffers are marked as temporary buffers in ESS, and are deleted when ess-quit
or ess-cleanup are called.
Help buffers normally appear in another window within the current frame. If you wish
help buffers to appear in their own frame (either one per help buffer, or one for all help
buffers), you can customize the variable ess-help-own-frame.