Function: help-buffer

help-buffer is an autoloaded and byte-compiled function defined in help-mode.el.gz.

Signature

(help-buffer)

Documentation

Return the name of a buffer for inserting help.

If help-xref-following is non-nil, this is the name of the current buffer. Signal an error if this buffer is not derived from help-mode. Otherwise, return "*Help*", creating a buffer with that name if it does not already exist.

Source Code

;; Defined in /usr/src/emacs/lisp/help-mode.el.gz
;;;###autoload
(defun help-buffer ()
  "Return the name of a buffer for inserting help.
If `help-xref-following' is non-nil, this is the name of the
current buffer.  Signal an error if this buffer is not derived
from `help-mode'.
Otherwise, return \"*Help*\", creating a buffer with that name if
it does not already exist."
  (buffer-name				;for with-output-to-temp-buffer
   (if (not help-xref-following)
       (get-buffer-create "*Help*")
     (unless (derived-mode-p 'help-mode)
       (error "Current buffer is not in Help mode"))
     (current-buffer))))