1 ;;; em-banner.el --- sample module that displays a login banner
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; There is nothing to be done or configured in order to use this
26 ;; module, other than to select it by customizing the variable
27 ;; `eshell-modules-list'. It will then display a version information
28 ;; message whenever Eshell is loaded.
30 ;; This code is only an example of a how to write a well-formed
31 ;; extension module for Eshell. The better way to display login text
32 ;; is to use the `eshell-script' module, and to echo the desired
33 ;; strings from the user's `eshell-login-script' file.
35 ;; There is one configuration variable, which demonstrates how to
36 ;; properly define a customization variable in an extension module.
37 ;; In this case, it allows the user to change the string which
38 ;; displays at login time.
49 (defgroup eshell-banner nil
50 "This sample module displays a welcome banner at login.
51 It exists so that others wishing to create their own Eshell extension
52 modules may have a simple template to begin with."
54 ;; :link '(info-link "(eshell)Login banner")
55 :group 'eshell-module)
59 (defcustom eshell-banner-message "Welcome to the Emacs shell\n\n"
60 "*The banner message to be displayed when Eshell is loaded.
61 This can be any sexp, and should end with at least two newlines."
63 :group 'eshell-banner)
65 (put 'eshell-banner-message 'risky-local-variable t)
67 (defcustom eshell-banner-load-hook '(eshell-banner-initialize)
68 "*A list of functions to run when `eshell-banner' is loaded."
70 :group 'eshell-banner)
72 (defun eshell-banner-initialize ()
73 "Output a welcome banner on initialization."
74 ;; it's important to use `eshell-interactive-print' rather than
75 ;; `insert', because `insert' doesn't know how to interact with the
76 ;; I/O code used by Eshell
77 (unless eshell-non-interactive-p
79 (assert eshell-banner-message)
80 (let ((msg (eval eshell-banner-message)))
82 (eshell-interactive-print msg))))
84 (eshell-deftest banner banner-displayed
85 "Startup banner is displayed at point-min"
86 (assert eshell-banner-message)
87 (let ((msg (eval eshell-banner-message)))
89 (goto-char (point-min))
94 ;; arch-tag: e738b4ef-8671-42ae-a757-291779b92491
95 ;;; em-banner.el ends here