Function: rst-minor-mode

rst-minor-mode is an autoloaded, interactive and byte-compiled function defined in rst.el.gz.

Signature

(rst-minor-mode &optional ARG)

Documentation

Toggle ReST minor mode.

This is a minor mode. If called interactively, toggle the Rst minor mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate rst-minor-mode(var)/rst-minor-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

When ReST minor mode is enabled, the ReST mode keybindings are installed on top of the major mode bindings. Use this for modes derived from Text mode, like Mail mode.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/rst.el.gz
;;;###autoload
(define-minor-mode rst-minor-mode
  "Toggle ReST minor mode.

When ReST minor mode is enabled, the ReST mode keybindings
are installed on top of the major mode bindings.  Use this
for modes derived from Text mode, like Mail mode."
  ;; The indicator for the mode line.
  :lighter " ReST"
  ;; The minor mode bindings.
  :keymap rst-mode-map
  :group 'rst)