Function: idlwave-help-mode

idlwave-help-mode is an interactive and byte-compiled function defined in idlw-help.el.gz.

Signature

(idlwave-help-mode)

Documentation

Major mode for displaying IDL Help.

This is a VIEW mode for the ASCII version of IDL Help files, with some extras. Its main purpose is speed - so don't expect a fully hyper-linked help.

Scrolling: SPC DEL RET
Text Searches: Inside Topic: Use Emacs search functions
Exit: [q]uit or mouse button 3 will kill the frame

When the help text is a source file, the following commands are available

Fontification: [F]ontify the buffer like source code
Jump: [h] to function doclib header
                    [H] to file doclib header
                    [.] back and forth between header and definition

Here are all keybindings.
. idlwave-help-toggle-header-match-and-def
<delete> scroll-down-command
F idlwave-help-fontify
H idlwave-help-find-first-header
M-? idlwave-help-return-to-calling-frame
RET #<anonymous-function>
S-SPC scroll-down-command
SPC scroll-up-command
h idlwave-help-find-header
q idlwave-help-quit
w widen
x idlwave-help-return-to-calling-frame

In addition to any hooks its parent mode special-mode might have run, this mode runs the hook idlwave-help-mode-hook, as the final or penultimate step during initialization.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/idlw-help.el.gz
(define-derived-mode idlwave-help-mode special-mode "IDLWAVE Help"
  "Major mode for displaying IDL Help.

This is a VIEW mode for the ASCII version of IDL Help files,
with some extras.  Its main purpose is speed - so don't
expect a fully hyper-linked help.

Scrolling:          SPC  DEL  RET
Text Searches:      Inside Topic: Use Emacs search functions
Exit:               [q]uit or mouse button 3 will kill the frame

When the help text is a source file, the following commands are available

Fontification:      [F]ontify the buffer like source code
Jump:               [h] to function doclib header
                    [H] to file doclib header
                    [.] back and forth between header and definition

Here are all keybindings.
\\{idlwave-help-mode-map}"
  (buffer-disable-undo)
  (setq truncate-lines t)
  (setq case-fold-search t)
  (setq mode-line-format
	(list ""
	      'mode-line-modified
	      'mode-line-buffer-identification
	      ":  " 'idlwave-help-mode-line-indicator
	      " -%-"))
  (setq buffer-read-only t)
  (set (make-local-variable 'idlwave-help-def-pos) nil)
  (set (make-local-variable 'idlwave-help-args) nil)
  (set (make-local-variable 'idlwave-help-in-header) nil))