File: em-banner.el.html

There is nothing to be done or configured in order to use this module, other than to select it by customizing the variable eshell-modules-list. It will then display a version information message whenever Eshell is loaded.

This code is only an example of a how to write a well-formed extension module for Eshell. The better way to display login text is to use the eshell-script module, and to echo the desired strings from the user's eshell-login-script file.

There is one configuration variable, which demonstrates how to properly define a customization variable in an extension module. In this case, it allows the user to change the string which displays at login time.

Defined variables (2)

eshell-banner-load-hookA list of functions to run when ‘eshell-banner’ is loaded.
eshell-banner-messageThe banner message to be displayed when Eshell is loaded.

Defined functions (1)

eshell-banner-initialize()

Defined faces (0)