(put 'Edit-options-mode 'mode-class 'special)
(defun Edit-options-mode ()
- "Major mode for editing Emacs user option settings.
+ "\\<Edit-options-mode-map>\
+Major mode for editing Emacs user option settings.
Special commands are:
-s -- set variable point points at. New value read using minibuffer.
-x -- toggle variable, t -> nil, nil -> t.
-1 -- set variable to t.
-0 -- set variable to nil.
+\\[Edit-options-set] -- set variable point points at. New value read using minibuffer.
+\\[Edit-options-toggle] -- toggle variable, t -> nil, nil -> t.
+\\[Edit-options-t] -- set variable to t.
+\\[Edit-options-nil] -- set variable to nil.
Changed values made by these commands take effect immediately.
Each variable description is a paragraph.
-For convenience, the characters p and n move back and forward by paragraphs."
+For convenience, the characters \\[backward-paragraph] and \\[forward-paragraph] move back and forward by paragraphs."
(kill-all-local-variables)
(set-syntax-table emacs-lisp-mode-syntax-table)
(use-local-map Edit-options-mode-map)
"Abbrev table used while in nroff mode.")
(defvar nroff-mode-map nil
- "Major mode keymap for nroff-mode buffers")
+ "Major mode keymap for nroff mode.")
(if (not nroff-mode-map)
(progn
(setq nroff-mode-map (make-sparse-keymap))
(defun nroff-mode ()
"Major mode for editing text intended for nroff to format.
\\{nroff-mode-map}
-Turning on Nroff mode runs text-mode-hook, then nroff-mode-hook.
-Also, try nroff-electric-mode, for automatically inserting
+Turning on Nroff mode runs `text-mode-hook', then `nroff-mode-hook'.
+Also, try `nroff-electric-mode', for automatically inserting
closing requests for requests that are used in matched pairs."
(interactive)
(kill-all-local-variables)
(defun electric-nroff-newline (arg)
"Insert newline for nroff mode; special if electric-nroff mode.
-In electric-nroff-mode, if ending a line containing an nroff opening request,
+In `electric-nroff-mode', if ending a line containing an nroff opening request,
automatically inserts the matching closing request after point."
(interactive "P")
(let ((completion (save-excursion
(forward-char 1))))
(defun electric-nroff-mode (&optional arg)
- "Toggle nroff-electric-newline minor mode
-Nroff-electric-newline forces emacs to check for an nroff
-request at the beginning of the line, and insert the
-matching closing request if necessary.
-This command toggles that mode (off->on, on->off),
-with an argument, turns it on iff arg is positive, otherwise off."
+ "Toggle `nroff-electric-newline' minor mode.
+`nroff-electric-newline' forces Emacs to check for an nroff request at the
+beginning of the line, and insert the matching closing request if necessary.
+This command toggles that mode (off->on, on->off), with an argument,
+turns it on iff arg is positive, otherwise off."
(interactive "P")
(or (eq major-mode 'nroff-mode) (error "Must be in nroff mode"))
(or (assq 'nroff-electric-mode minor-mode-alist)