Variable: TeX-doc-backend-alist

TeX-doc-backend-alist is a variable defined in tex.el.

Value

((texdoc
  (plain-TeX-mode LaTeX-mode docTeX-mode AmSTeX-mode ConTeXt-mode)
  (lambda nil
    (when (executable-find "texdoc")
      (TeX-search-files-by-type 'docs 'global t t)))
  (lambda (doc) (call-process "texdoc" nil 0 nil "--view" doc)))
 (latex-info (LaTeX-mode)
	     (lambda nil
	       (mapcar
		(lambda (x)
		  (let ((x (car x)))
		    (if (string-match "\\`\\\\" x) (substring x 1) x)))
		(info-lookup->completions 'symbol 'LaTeX-mode)))
	     (lambda (doc)
	       (info-lookup-symbol (concat "\\" doc) 'LaTeX-mode)))
 (texinfo-info (Texinfo-mode)
	       (lambda nil
		 (mapcar
		  (lambda (x)
		    (let ((x (car x)))
		      (if (string-match "\\`@" x) (substring x 1) x)))
		  (info-lookup->completions 'symbol 'Texinfo-mode)))
	       (lambda (doc)
		 (info-lookup-symbol (concat "@" doc) 'Texinfo-mode))))

Documentation

Alist of backends used for looking up documentation.

Each item consists of four elements.

The first is a symbol describing the backend's name.

The second is either a list of modes the backend should be activated in, or the symbol t, which stands for all modes.

The third is a function returning a list of documents available to the backend. It should return nil if the backend is not available, for example if a required executable is not present on the system in question.

The fourth is a function for displaying the documentation. The function should accept a single argument, the chosen package, command, or document name.

Source Code

;; Defined in ~/.emacs.d/elpa/auctex-14.1.2/tex.el
(defvar TeX-doc-backend-alist
  '((texdoc (plain-TeX-mode LaTeX-mode docTeX-mode AmSTeX-mode ConTeXt-mode)
            (lambda ()
              (when (executable-find "texdoc")
                (TeX-search-files-by-type 'docs 'global t t)))
            (lambda (doc)
              ;; texdoc in MiKTeX requires --view in order to start
              ;; the viewer instead of an intermediate web page.
              (call-process "texdoc" nil 0 nil "--view" doc)))
    (latex-info (LaTeX-mode)
                (lambda ()
                  (mapcar (lambda (x)
                            (let ((x (car x)))
                              (if (string-match "\\`\\\\" x)
                                  (substring x 1) x)))
                          (info-lookup->completions 'symbol 'LaTeX-mode)))
                (lambda (doc)
                  (info-lookup-symbol (concat "\\" doc) 'LaTeX-mode)))
    (texinfo-info (Texinfo-mode)
                  (lambda ()
                    (mapcar (lambda (x)
                              (let ((x (car x)))
                                (if (string-match "\\`@" x)
                                    (substring x 1) x)))
                            (info-lookup->completions 'symbol
                                                      'Texinfo-mode)))
                  (lambda (doc)
                    (info-lookup-symbol (concat "@" doc) 'Texinfo-mode))))
  "Alist of backends used for looking up documentation.
Each item consists of four elements.

The first is a symbol describing the backend's name.

The second is either a list of modes the backend should be activated in,
or the symbol t, which stands for all modes.

The third is a function returning a list of documents available
to the backend.  It should return nil if the backend is not
available, for example if a required executable is not present on the
system in question.

The fourth is a function for displaying the documentation.  The
function should accept a single argument, the chosen package,
command, or document name.")