Variable: eshell-special-ref-alist

eshell-special-ref-alist is a variable defined in esh-arg.el.gz.

Value

(("buffer" (creation-function eshell-get-buffer)
  (insertion-function eshell-insert-buffer-name)
  (completion-function eshell-complete-buffer-ref))
 ("marker" (creation-function eshell-get-marker)
  (insertion-function eshell-insert-marker)
  (completion-function eshell-complete-marker-ref)))

Documentation

Alist of special reference types for Eshell.

Each entry is a list of the form (TYPE (KEY VALUE)...). TYPE is the name of the special reference type, and each KEY/VALUE pair represents a parameter for the type. Eshell defines the following KEYs:

* creation-function
  A function taking any number of arguments that returns the Lisp
  object for this special ref type.

* insertion-function
  An interactive function that returns the special reference in
  string form. This string should look like "#<TYPE ARG...>";
  Eshell will pass the ARGs to creation-function.

* completion-function
  A function using Pcomplete to perform completion on any
  arguments necessary for creating this special reference type.

Source Code

;; Defined in /usr/src/emacs/lisp/eshell/esh-arg.el.gz
(defvar eshell-special-ref-alist
  '(("buffer"
     (creation-function   eshell-get-buffer)
     (insertion-function  eshell-insert-buffer-name)
     (completion-function eshell-complete-buffer-ref))
    ("marker"
     (creation-function   eshell-get-marker)
     (insertion-function  eshell-insert-marker)
     (completion-function eshell-complete-marker-ref)))
  "Alist of special reference types for Eshell.
Each entry is a list of the form (TYPE (KEY VALUE)...).  TYPE is
the name of the special reference type, and each KEY/VALUE pair
represents a parameter for the type.  Eshell defines the
following KEYs:

* `creation-function'
  A function taking any number of arguments that returns the Lisp
  object for this special ref type.

* `insertion-function'
  An interactive function that returns the special reference in
  string form.  This string should look like \"#<TYPE ARG...>\";
  Eshell will pass the ARGs to `creation-function'.

* `completion-function'
  A function using Pcomplete to perform completion on any
  arguments necessary for creating this special reference type.")