start-emacs-lisp-interface

$Revision: 5.0.2.4 $

Function

Package: EXCL

Arguments: (&optional use-background-streams emacs-listener-number)

This function starts the emacs-lisp interface. In order for it to have effect, Lisp must have been started as a subprocess of Emacs using fi:common-lisp, as described in eli/readme.htm.

When a Lisp is started with fi:common-lisp,

-e (start-emacs-lisp-interface t)

(or an equivalent form) is made a command line argument to Lisp. If, because command-line arguments are ignored, the Emacs-Lisp interface does not start up (or if it does not start up for any other reason), you can start it directly from within Lisp by calling the this function.

The default value of use-background-streams is t. If use-background-streams in non-nil, then the Common Lisp function use-background-streams is used to initialize background streams. The value of use-background-streams is passed to the function use-background-streams (see 4.0 Debugging background processes in debugging.htm).

The emacs-listener-number argument should not be specified by users calling this function.

The typical form that will start the Emacs-Lisp interface is:

(excl:start-emacs-lisp-interface t)

It is not an error to call this function when the Emacs-Lisp interface is in fact running. Doing so will cause some printing to the listener but have no other effect.

See eli/readme.htm for information on the Emacs-Lisp interface.

The general documentation description is in introduction.htm. The index is in index.htm.