annotate lisp/eshell/eshell.el @ 79707:48c4bb2b7d11

Add 2008 to copyright years.
author Glenn Morris <rgm@gnu.org>
date Mon, 07 Jan 2008 01:14:52 +0000
parents a1e8300d3c55
children 107ccd98fa12
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38414
67b464da13ec Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 38120
diff changeset
1 ;;; eshell.el --- the Emacs command shell
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
2
74509
f7702c5f335d Update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 69385
diff changeset
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
79707
48c4bb2b7d11 Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78220
diff changeset
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
5
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
6 ;; Author: John Wiegley <johnw@gnu.org>
38120
64002802a902 Added a version string.
John Wiegley <johnw@newartisans.com>
parents: 38119
diff changeset
7 ;; Version: 2.4.2
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
8 ;; Keywords: processes
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
11
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
78220
a1e8300d3c55 Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 75346
diff changeset
14 ;; the Free Software Foundation; either version 3, or (at your option)
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
15 ;; any later version.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
16
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
20 ;; GNU General Public License for more details.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
21
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64085
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 54564
diff changeset
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 54564
diff changeset
25 ;; Boston, MA 02110-1301, USA.
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
26
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
27 (provide 'eshell)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
28
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
29 (eval-when-compile (require 'esh-maint))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
30
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
31 (defgroup eshell nil
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
32 "Eshell is a command shell implemented entirely in Emacs Lisp. It
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
33 invokes no external processes beyond those requested by the user. It
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
34 is intended to be a functional replacement for command shells such as
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
35 bash, zsh, rc, 4dos; since Emacs itself is capable of handling most of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
36 the tasks accomplished by such tools."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
37 :tag "The Emacs shell"
54564
9915b3ca4e0f (eshell): Fix broken info-link.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
38 :link '(info-link "(eshell)Top")
31949
a511ba2b1746 (eshell) <defgroup>: Add :version.
Dave Love <fx@gnu.org>
parents: 30271
diff changeset
39 :version "21.1"
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
40 :group 'applications)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
41
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
42 ;;; Commentary:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
43
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44 ;;;_* What does Eshell offer you?
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
45 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46 ;; Despite the sheer fact that running an Emacs shell can be fun, here
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
47 ;; are a few of the unique features offered by Eshell:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
48 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
49 ;; @ Integration with the Emacs Lisp programming environment
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
50 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
51 ;; @ A high degree of configurability
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
52 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
53 ;; @ The ability to have the same shell on every system Emacs has been
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
54 ;; ported to. Since Eshell imposes no external requirements, and
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
55 ;; relies upon only the Lisp functions exposed by Emacs, it is quite
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
56 ;; operating system independent. Several of the common UNIX
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
57 ;; commands, such as ls, mv, rm, ln, etc., have been implemented in
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
58 ;; Lisp in order to provide a more consistent work environment.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
60 ;; For those who might be using an older version of Eshell, version
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
61 ;; 2.1 represents an entirely new, module-based architecture. It
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
62 ;; supports most of the features offered by modern shells. Here is a
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 ;; brief list of some of its more visible features:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
64 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
65 ;; @ Command argument completion (tcsh, zsh)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66 ;; @ Input history management (bash)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
67 ;; @ Intelligent output scrolling
50937
dfc70cb4fd02 Fix typo in comment.
Juanma Barranquero <lekktu@gmail.com>
parents: 46705
diff changeset
68 ;; @ Pseudo-devices (such as "/dev/clip" for copying to the clipboard)
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
69 ;; @ Extended globbing (zsh)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 ;; @ Argument and globbing predication (zsh)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71 ;; @ I/O redirection to buffers, files, symbols, processes, etc.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
72 ;; @ Many niceties otherwise seen only in 4DOS
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73 ;; @ Alias functions, both Lisp and Eshell-syntax
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74 ;; @ Piping, sequenced commands, background jobs, etc...
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
75 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
76 ;;;_* Eshell is free software
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
77 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
78 ;; Eshell is free software; you can redistribute it and/or modify it
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
79 ;; under the terms of the GNU General Public License as published by
78220
a1e8300d3c55 Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 75346
diff changeset
80 ;; the Free Software Foundation; either version 3, or (at your option)
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 ;; any later version.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83 ;; This program is distributed in the hope that it will be useful, but
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86 ;; General Public License for more details.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
87 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
88 ;; You should have received a copy of the GNU General Public License
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
89 ;; along with Eshell; see the file COPYING. If not, write to the Free
64092
e055d02d8b97 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 64085
diff changeset
90 ;; Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
e055d02d8b97 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 64085
diff changeset
91 ;; MA 02110-1301, USA.
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
92 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
93 ;;;_* How to begin
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
94 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
95 ;; To start using Eshell, add the following to your .emacs file:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
96 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
97 ;; (load "eshell-auto")
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
98 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
99 ;; This will define all of the necessary autoloads.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
100 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
101 ;; Now type `M-x eshell'. See the INSTALL file for full installation
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
102 ;; instructions.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
103 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
104 ;;;_* Philosophy
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
105 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
106 ;; A shell is a layer which metaphorically surrounds the kernel, or
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
107 ;; heart of an operating system. This kernel can be seen as an engine
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
108 ;; of pure functionality, waiting to serve, while the user programs
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
109 ;; take advantage of that functionality to accomplish their purpose.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
110 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
111 ;; The shell's role is to make that functionality accessible to the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
112 ;; user in an unformed state. Very roughly, it associates kernel
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
113 ;; functionality with textual commands, allowing the user to interact
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
114 ;; with the operating system via linguistic constructs. Process
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
115 ;; invocation is perhaps the most significant form this takes, using
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
116 ;; the kernel's `fork' and `exec' functions.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
117 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
118 ;; Other programs also interact with the functionality of the kernel,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
119 ;; but these user applications typically offer a specific range of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
120 ;; functionality, and thus are not classed as "shells" proper.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
121 ;; (What they lose in quiddity, they gain in rigidity).
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
122 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
123 ;; Emacs is also a user application, but it does make the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
124 ;; functionality of the kernel accessible through an interpreted
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
125 ;; language -- namely, Lisp. For that reason, there is little
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
126 ;; preventing Emacs from serving the same role as a modern shell. It
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
127 ;; too can manipulate the kernel in an unpredetermined way to cause
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
128 ;; system changes. All it's missing is the shell-ish linguistic
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
129 ;; model.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
130 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
131 ;; Enter Eshell. Eshell translates "shell-like" syntax into Lisp
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
132 ;; in order to exercise the kernel in the same manner as typical
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
133 ;; system shells. There is a fundamental difference here, however,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
134 ;; although it may seem subtle at first...
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
135 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
136 ;; Shells like csh and Bourne shell were written several decades ago,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
137 ;; in different times, under more restrictive circumstances. This
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
138 ;; confined perspective shows itself in the paradigm used by nearly
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
139 ;; all command-line shells since. They are linear in conception, byte
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
140 ;; stream-based, sequential, and confined to movement within a single
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
141 ;; host machine.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
142 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
143 ;; Emacs, on the other hand, is more than just a limited translator
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
144 ;; that can invoke subprocesses and redirect file handles. It also
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
145 ;; manages character buffers, windowing frames, network connections,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
146 ;; registers, bookmarks, processes, etc. In other words, it's a very
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
147 ;; multi-dimensional environment, within which eshell emulates a highly
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
148 ;; linear methodology.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
149 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
150 ;; Taking a moment, let's look at how this could affect the future of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
151 ;; a shell allowed to develop in such a wider field of play:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
152 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
153 ;; @ There is no reason why directory movement should be linear, and
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
154 ;; confined to a single file-system. Emacs, through w3 and ange-ftp,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
155 ;; has access to the entire Web. Why not allow a user to cd to
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
156 ;; multiple directories simultaneously, for example? It might make
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
157 ;; some tasks easier, such as diff'ing files separated by very long
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
158 ;; pathnames.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
159 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
160 ;; @ Data sources are available from anywhere Emacs can derive
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
161 ;; information from: not just from files or the output of other
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
162 ;; processes.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
163 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
164 ;; @ Multiple shell invocations all share the same environment -- even
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
165 ;; the same process list! It would be possible to have "process
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
166 ;; views", so that one buffer is watching standard output, another
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
167 ;; standard error, and another the result of standard output grep'd
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
168 ;; through a regular expression...
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
169 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
170 ;; @ It is not necessary to "leave" the shell, losing all input and
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
171 ;; output history, environment variables, directory stack, etc.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
172 ;; Emacs could save the contents of your eshell environment, and
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
173 ;; restore all of it (or at least as much as possible) each time you
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
174 ;; restart. This could occur automatically, without requiring
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
175 ;; complex initialization scripts.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
176 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
177 ;; @ Typos occur all of the time; many of them are repeats of common
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
178 ;; errors, such as 'dri' for `dir'. Since executing non-existent
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
179 ;; programs is rarely the intention of the user, eshell could prompt
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
180 ;; for the replacement string, and then record that in a database of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
181 ;; known misspellings. (Note: The typo at the beginning of this
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
182 ;; paragraph wasn't discovered until two months after I wrote the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
183 ;; text; it was not intentional).
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
184 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
185 ;; @ Emacs' register and bookmarking facilities can be used for
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
186 ;; remembering where you've been, and what you've seen -- to varying
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
187 ;; levels of persistence. They could perhaps even be tied to
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
188 ;; specific "moments" during eshell execution, which would include
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
189 ;; the environment at that time, as well as other variables.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
190 ;; Although this would require functionality orthogonal to Emacs'
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
191 ;; own bookmarking facilities, the interface used could be made to
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
192 ;; operate very similarly.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
193 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
194 ;; This presents a brief idea of what the fuller dimensionality of an
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
195 ;; Emacs shell could offer. It's not just the language of a shell
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
196 ;; that determines how it's used, but also the Weltanschauung
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
197 ;; underlying its design -- and which is felt behind even the smallest
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
198 ;; feature. I would hope the freedom provided by using Emacs as a
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
199 ;; parent environment will invite rich ideas from others. It
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
200 ;; certainly feels as though all I've done so far is to tie down the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
201 ;; horse, so to speak, so that he will run at a man's pace.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
202 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
203 ;;;_* Influences
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
204 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
205 ;; The author of Eshell has been a long-time user of the following
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
206 ;; shells, all of which contributed to Eshell's design:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
207 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
208 ;; @ rc
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
209 ;; @ bash
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
210 ;; @ zsh
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
211 ;; @ sh
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
212 ;; @ 4nt
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
213 ;; @ csh
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
214
38119
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
215 ;;;_* Speeding up load time
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
216 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
217 ;; If you find that Eshell loads too slowly, there is something you
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
218 ;; can do to speed it up.
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
219 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
220 ;; Create a file, named /tmp/elc, containing this filelist:
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
221 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
222 ;; esh-util.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
223 ;; eshell.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
224 ;; esh-module.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
225 ;; esh-var.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
226 ;; esh-proc.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
227 ;; esh-arg.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
228 ;; esh-io.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
229 ;; esh-ext.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
230 ;; esh-cmd.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
231 ;; esh-mode.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
232 ;; esh-opt.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
233 ;; em-alias.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
234 ;; em-banner.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
235 ;; em-basic.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
236 ;; em-cmpl.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
237 ;; em-dirs.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
238 ;; em-pred.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
239 ;; em-glob.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
240 ;; em-hist.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
241 ;; em-ls.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
242 ;; em-prompt.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
243 ;; em-rebind.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
244 ;; em-script.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
245 ;; em-smart.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
246 ;; em-term.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
247 ;; em-unix.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
248 ;; em-xtra.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
249 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
250 ;; The order is very important. Remove from the filelist any features
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
251 ;; you don't use. These all begin with "em-". If you don't use
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
252 ;; Eshell's key rebinding module, you can remove "em-rebind.elc" from
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
253 ;; the filelist. The modules you are currently using are listed in
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
254 ;; `eshell-modules-list'.
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
255 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
256 ;; Now, concatenating all of the above mentioned .elc files, in that
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
257 ;; order, to another file. Here is how to do this on UNIX:
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
258 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
259 ;; cat `cat /tmp/elc` > tmp.elc ; mv tmp.elc eshell.elc
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
260 ;;
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
261 ;; Now your eshell.elc file contains all of the .elc files that make
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
262 ;; up Eshell, in the right load order. When you next load Eshell, it
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
263 ;; will only have to read in this one file, which will greatly speed
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
264 ;; things up.
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
265
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
266 ;;;_* User Options
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
267 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
268 ;; The following user options modify the behavior of Eshell overall.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
269
38119
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
270 (unless (featurep 'esh-util)
9c0099738383 Don't load in esh-util if it's already loaded. Also, added a comment
John Wiegley <johnw@newartisans.com>
parents: 37436
diff changeset
271 (load "esh-util" nil t))
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
272
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
273 (defsubst eshell-add-to-window-buffer-names ()
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
274 "Add `eshell-buffer-name' to `same-window-buffer-names'."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
275 (add-to-list 'same-window-buffer-names eshell-buffer-name))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
276
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
277 (defsubst eshell-remove-from-window-buffer-names ()
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
278 "Remove `eshell-buffer-name' from `same-window-buffer-names'."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
279 (setq same-window-buffer-names
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
280 (delete eshell-buffer-name same-window-buffer-names)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
281
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
282 (defcustom eshell-load-hook nil
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
283 "*A hook run once Eshell has been loaded."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
284 :type 'hook
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
285 :group 'eshell)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
286
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
287 (defcustom eshell-unload-hook
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
288 '(eshell-remove-from-window-buffer-names
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
289 eshell-unload-all-modules)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
290 "*A hook run when Eshell is unloaded from memory."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
291 :type 'hook
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
292 :group 'eshell)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
293
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
294 (defcustom eshell-buffer-name "*eshell*"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
295 "*The basename used for Eshell buffers."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
296 :set (lambda (symbol value)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
297 ;; remove the old value of `eshell-buffer-name', if present
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
298 (if (boundp 'eshell-buffer-name)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
299 (eshell-remove-from-window-buffer-names))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
300 (set symbol value)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
301 ;; add the new value
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
302 (eshell-add-to-window-buffer-names)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
303 value)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
304 :type 'string
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
305 :group 'eshell)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
306
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
307 (eshell-deftest mode same-window-buffer-names
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
308 "`eshell-buffer-name' is a member of `same-window-buffer-names'"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
309 (member eshell-buffer-name same-window-buffer-names))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
310
30271
54ff6ef3d884 (eshell-directory-name): Run default directory
Eli Zaretskii <eliz@gnu.org>
parents: 29934
diff changeset
311 (defcustom eshell-directory-name (convert-standard-filename "~/.eshell/")
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
312 "*The directory where Eshell control files should be kept."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
313 :type 'directory
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
314 :group 'eshell)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
315
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
316 (eshell-deftest mode eshell-directory-exists
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
317 "`eshell-directory-name' exists and is writable"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
318 (file-writable-p eshell-directory-name))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
319
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
320 (eshell-deftest mode eshell-directory-modes
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
321 "`eshell-directory-name' has correct access protections"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
322 (or (eshell-under-windows-p)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
323 (= (file-modes eshell-directory-name)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
324 eshell-private-directory-modes)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
325
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
326 ;;;_* Running Eshell
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
327 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
328 ;; There are only three commands used to invoke Eshell. The first two
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
329 ;; are intended for interactive use, while the third is meant for
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
330 ;; programmers. They are:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
331
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
332 ;;;###autoload
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
333 (defun eshell (&optional arg)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
334 "Create an interactive Eshell buffer.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
335 The buffer used for Eshell sessions is determined by the value of
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
336 `eshell-buffer-name'. If there is already an Eshell session active in
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
337 that buffer, Emacs will simply switch to it. Otherwise, a new session
46705
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
338 will begin. A numeric prefix arg (as in `C-u 42 M-x eshell RET')
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
339 switches to the session with that number, creating it if necessary. A
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
340 nonnumeric prefix arg means to create a new session. Returns the
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
341 buffer selected (or created)."
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
342 (interactive "P")
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
343 (assert eshell-buffer-name)
46705
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
344 (let ((buf (cond ((numberp arg)
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
345 (get-buffer-create (format "%s<%d>"
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
346 eshell-buffer-name
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
347 arg)))
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
348 (arg
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
349 (generate-new-buffer eshell-buffer-name))
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
350 (t
9f4f7bee7b8d (eshell): Numeric prefix arg means to switch
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 43321
diff changeset
351 (get-buffer-create eshell-buffer-name)))))
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
352 ;; Simply calling `pop-to-buffer' will not mimic the way that
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
353 ;; shell-mode buffers appear, since they always reuse the same
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
354 ;; window that that command was invoked from. To achieve this,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
355 ;; it's necessary to add `eshell-buffer-name' to the variable
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
356 ;; `same-window-buffer-names', which is done when Eshell is loaded
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
357 (assert (and buf (buffer-live-p buf)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
358 (pop-to-buffer buf)
64830
e5c6f54442d2 (eshell): Avoid warnings about eshell-mode.
Richard M. Stallman <rms@gnu.org>
parents: 64701
diff changeset
359 (if (fboundp 'eshell-mode)
e5c6f54442d2 (eshell): Avoid warnings about eshell-mode.
Richard M. Stallman <rms@gnu.org>
parents: 64701
diff changeset
360 (unless (eq major-mode 'eshell-mode)
e5c6f54442d2 (eshell): Avoid warnings about eshell-mode.
Richard M. Stallman <rms@gnu.org>
parents: 64701
diff changeset
361 (eshell-mode))
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
362 (error "`eshell-auto' must be loaded before Eshell can be used"))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
363 buf))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
364
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
365 (defun eshell-return-exits-minibuffer ()
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
366 (define-key eshell-mode-map [(control ?g)] 'abort-recursive-edit)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
367 (define-key eshell-mode-map [return] 'exit-minibuffer)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
368 (define-key eshell-mode-map [(control ?m)] 'exit-minibuffer)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
369 (define-key eshell-mode-map [(control ?j)] 'exit-minibuffer)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
370 (define-key eshell-mode-map [(meta return)] 'exit-minibuffer)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
371 (define-key eshell-mode-map [(meta control ?m)] 'exit-minibuffer))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
372
37436
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
373 (defvar eshell-non-interactive-p nil
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
374 "A variable which is non-nil when Eshell is not running interactively.
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
375 Modules should use this variable so that they don't clutter
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
376 non-interactive sessions, such as when using `eshell-command'.")
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
377
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
378 ;;;###autoload
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
379 (defun eshell-command (&optional command arg)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
380 "Execute the Eshell command string COMMAND.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
381 With prefix ARG, insert output into the current buffer at point."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
382 (interactive)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
383 (require 'esh-cmd)
37436
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
384 (unless arg
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
385 (setq arg current-prefix-arg))
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
386 (unwind-protect
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
387 (let ((eshell-non-interactive-p t))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
388 (add-hook 'minibuffer-setup-hook 'eshell-mode)
43321
358616bbe6a1 (eshell-command): Before reading from the minibuffer, add
John Wiegley <johnw@newartisans.com>
parents: 42686
diff changeset
389 (add-hook 'minibuffer-exit-hook 'eshell-add-command-to-history)
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
390 (add-hook 'eshell-mode-hook 'eshell-return-exits-minibuffer)
37436
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
391 (unless command
33a9a90f3e76 (eshell-command): Made a few changes so that `eshell-command' could be
John Wiegley <johnw@newartisans.com>
parents: 37281
diff changeset
392 (setq command (read-from-minibuffer "Emacs shell command: "))))
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
393 (remove-hook 'eshell-mode-hook 'eshell-return-exits-minibuffer)
43321
358616bbe6a1 (eshell-command): Before reading from the minibuffer, add
John Wiegley <johnw@newartisans.com>
parents: 42686
diff changeset
394 (remove-hook 'minibuffer-exit-hook 'eshell-add-command-to-history)
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
395 (remove-hook 'minibuffer-setup-hook 'eshell-mode))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
396 (unless command
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
397 (error "No command specified!"))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
398 ;; redirection into the current buffer is achieved by adding an
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
399 ;; output redirection to the end of the command, of the form
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
400 ;; 'COMMAND >>> #<buffer BUFFER>'. This will not interfere with
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
401 ;; other redirections, since multiple redirections merely cause the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
402 ;; output to be copied to multiple target locations
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
403 (if arg
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
404 (setq command
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
405 (concat command
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
406 (format " >>> #<buffer %s>"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
407 (buffer-name (current-buffer))))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
408 (save-excursion
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
409 (require 'esh-mode)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
410 (let ((buf (set-buffer (generate-new-buffer " *eshell cmd*")))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
411 (eshell-non-interactive-p t))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
412 (eshell-mode)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
413 (let* ((proc (eshell-eval-command
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
414 (list 'eshell-commands
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
415 (eshell-parse-command command))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
416 intr
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
417 (bufname (if (and proc (listp proc))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
418 "*EShell Async Command Output*"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
419 (setq intr t)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
420 "*EShell Command Output*")))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
421 (if (buffer-live-p (get-buffer bufname))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
422 (kill-buffer bufname))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
423 (rename-buffer bufname)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
424 ;; things get a little coarse here, since the desire is to
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
425 ;; make the output as attractive as possible, with no
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
426 ;; extraneous newlines
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
427 (when intr
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
428 (if (eshell-interactive-process)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
429 (eshell-wait-for-process (eshell-interactive-process)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
430 (assert (not (eshell-interactive-process)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
431 (goto-char (point-max))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
432 (while (and (bolp) (not (bobp)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
433 (delete-backward-char 1)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
434 (assert (and buf (buffer-live-p buf)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
435 (unless arg
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
436 (let ((len (if (not intr) 2
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
437 (count-lines (point-min) (point-max)))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
438 (cond
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
439 ((= len 0)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
440 (message "(There was no command output)")
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
441 (kill-buffer buf))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
442 ((= len 1)
37281
85c38f2eac06 (eshell-command): Needed a "%s" format specifier, in case the buffer
John Wiegley <johnw@newartisans.com>
parents: 32451
diff changeset
443 (message "%s" (buffer-string))
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
444 (kill-buffer buf))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
445 (t
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
446 (save-selected-window
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
447 (select-window (display-buffer buf))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
448 (goto-char (point-min))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
449 ;; cause the output buffer to take up as little screen
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
450 ;; real-estate as possible, if temp buffer resizing is
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
451 ;; enabled
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
452 (and intr temp-buffer-resize-mode
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
453 (resize-temp-buffer-window)))))))))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
454
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
455 ;;;###autoload
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
456 (defun eshell-command-result (command &optional status-var)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
457 "Execute the given Eshell COMMAND, and return the result.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
458 The result might be any Lisp object.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
459 If STATUS-VAR is a symbol, it will be set to the exit status of the
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
460 command. This is the only way to determine whether the value returned
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
461 corresponding to a successful execution."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
462 ;; a null command produces a null, successful result
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
463 (if (not command)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
464 (ignore
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
465 (if (and status-var (symbolp status-var))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
466 (set status-var 0)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
467 (with-temp-buffer
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
468 (require 'esh-mode)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
469 (let ((eshell-non-interactive-p t))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
470 (eshell-mode)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
471 (let ((result (eshell-do-eval
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
472 (list 'eshell-commands
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
473 (list 'eshell-command-to-value
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
474 (eshell-parse-command command))) t)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
475 (assert (eq (car result) 'quote))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
476 (if (and status-var (symbolp status-var))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
477 (set status-var eshell-last-command-status))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
478 (cadr result))))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
479
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
480 (eshell-deftest mode simple-command-result
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
481 "`eshell-command-result' works with a simple command."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
482 (= (eshell-command-result "+ 1 2") 3))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
483
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
484 ;;;_* Reporting bugs
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
485 ;;
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
486 ;; Since Eshell has not yet been in use by a wide audience, and since
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
487 ;; the number of possible configurations is quite large, it is certain
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
488 ;; that many bugs slipped past the rigors of testing it was put
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
489 ;; through. If you do encounter a bug, on any system, please report
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
490 ;; it -- in addition to any particular oddities in your configuration
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
491 ;; -- so that the problem may be corrected for the benefit of others.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
492
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
493 (defconst eshell-report-bug-address "johnw@gnu.org"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
494 "E-mail address to send Eshell bug reports to.")
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
495
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
496 ;;;###autoload
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
497 (defun eshell-report-bug (topic)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
498 "Report a bug in Eshell.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
499 Prompts for the TOPIC. Leaves you in a mail buffer.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
500 Please include any configuration details that might be involved."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
501 (interactive "sBug Subject: ")
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
502 (compose-mail eshell-report-bug-address topic)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
503 (goto-char (point-min))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
504 (re-search-forward (concat "^" (regexp-quote mail-header-separator) "$"))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
505 (forward-line 1)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
506 (let ((signature (buffer-substring (point) (point-max))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
507 ;; Discourage users from writing non-English text.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
508 (set-buffer-multibyte nil)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
509 (delete-region (point) (point-max))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
510 (insert signature)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
511 (backward-char (length signature)))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
512 (insert "emacs-version: " (emacs-version))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
513 (insert "\n\nThere appears to be a bug in Eshell.\n\n"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
514 "Please describe exactly what actions "
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
515 "triggered the bug and the precise\n"
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
516 "symptoms of the bug:\n\n")
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
517 ;; This is so the user has to type something in order to send
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
518 ;; the report easily.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
519 (use-local-map (nconc (make-sparse-keymap) (current-local-map))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
520
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
521 ;;; Code:
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
522
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
523 (defun eshell-unload-all-modules ()
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
524 "Unload all modules that were loaded by Eshell, if possible.
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
525 If the user has require'd in any of the modules, or customized a
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
526 variable with a :require tag (such as `eshell-prefer-to-shell'), it
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
527 will be impossible to unload Eshell completely without restarting
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
528 Emacs."
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
529 ;; if the user set `eshell-prefer-to-shell' to t, but never loaded
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
530 ;; Eshell, then `eshell-subgroups' will be unbound
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
531 (when (fboundp 'eshell-subgroups)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
532 (eshell-for module (eshell-subgroups 'eshell)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
533 ;; this really only unloads as many modules as possible,
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
534 ;; since other `require' references (such as by customizing
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
535 ;; `eshell-prefer-to-shell' to a non-nil value) might make it
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
536 ;; impossible to unload Eshell completely
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
537 (if (featurep module)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
538 (ignore-errors
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
539 (message "Unloading %s..." (symbol-name module))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
540 (unload-feature module)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
541 (message "Unloading %s...done" (symbol-name module)))))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
542 (message "Unloading eshell...done")))
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
543
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
544 (run-hooks 'eshell-load-hook)
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
545
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 50937
diff changeset
546 ;;; arch-tag: 9d4d5214-0e4e-4e02-b349-39add640d63f
29876
edfec1c0d511 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
547 ;;; eshell.el ends here