Mercurial > emacs
annotate man/eshell.texi @ 35036:956652ab5efc
%X, %E, %G in format strings.
author | Dave Love <fx@gnu.org> |
---|---|
date | Thu, 04 Jan 2001 11:31:56 +0000 |
parents | dd613770eb0f |
children | 31904bdf4350 |
rev | line source |
---|---|
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
1 \input texinfo @c -*-texinfo-*- |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
2 |
34304 | 3 @c "@(#)$Name: $:$Id: eshell.texi,v 1.6 2000/10/29 16:52:33 eliz Exp $" |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
4 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
5 @c Documentation for Eshell: The Emacs Shell. |
34304 | 6 @c Copyright (C) 1999, 2000 Free Software Foundation, Inc. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
7 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
8 @c This file is part of GNU Emacs |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
9 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
10 @c GNU Emacs is free software; you can redistribute it and/or modify it |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
11 @c under the terms of the GNU General Public License as published by the |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
12 @c Free Software Foundation; either version 2 of the License, or (at |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
13 @c your option) any later version. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
14 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
15 @c GNU Emacs is distributed in the hope that it will be useful, but |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
16 @c WITHOUT ANY WARRANTY; without even the implied warraonty of |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
17 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
18 @c General Public License for more details. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
19 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
20 @c You should have received a copy of the GNU General Public License |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
21 @c along with Eshell; see the file COPYING. If not, write to the Free |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
22 @c Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
23 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
24 @c %**start of header |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
25 @setfilename ../info/eshell |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
26 @settitle Eshell: The Emacs Shell |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
27 @c %**end of header |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
28 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
29 @dircategory Emacs |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
30 @direntry |
33020 | 31 * Eshell: (eshell). A command shell implemented in Emacs Lisp. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
32 @end direntry |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
33 @setchapternewpage on |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
34 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
35 @ifinfo |
34304 | 36 Copyright @copyright{} 1999, 2000 Free Software Foundation, Inc. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
37 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
38 Permission is granted to make and distribute verbatim copies of this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
39 manual provided the copyright notice and this permission notice are |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
40 preserved on all copies. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
41 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
42 @ignore |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
43 Permission is granted to process this file through TeX and print the |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
44 results, provided the printed document carries copying permission notice |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
45 identical to this one except for the removal of this paragraph (this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
46 paragraph not being relevant to the printed manual). |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
47 @end ignore |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
48 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
49 Permission is granted to copy and distribute modified versions of this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
50 manual under the conditions for verbatim copying, provided also that the |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
51 section entitled ``GNU General Public License'' is included exactly as |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
52 in the original, and provided that the entire resulting derived work is |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
53 distributed under the terms of a permission notice identical to this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
54 one. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
55 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
56 Permission is granted to copy and distribute translations of this manual |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
57 into another language, under the above conditions for modified versions, |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
58 except that the section entitled ``GNU General Public License'' and this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
59 permission notice may be included in translations approved by the Free |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
60 Software Foundation instead of in the original English. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
61 @end ifinfo |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
62 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
63 @synindex vr fn |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
64 @c The titlepage section does not appear in the Info file. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
65 @titlepage |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
66 @sp 4 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
67 @c The title is printed in a large font. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
68 @center @titlefont{User's Guide} |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
69 @sp |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
70 @center @titlefont{to} |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
71 @sp |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
72 @center @titlefont{Eshell: The Emacs Shell} |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
73 @ignore |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
74 @sp 2 |
33020 | 75 @center release 2.4 |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
76 @c -release- |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
77 @end ignore |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
78 @sp 3 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
79 @center John Wiegley |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
80 @c -date- |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
81 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
82 @c The following two commands start the copyright page for the printed |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
83 @c manual. This will not appear in the Info file. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
84 @page |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
85 @vskip 0pt plus 1filll |
34304 | 86 Copyright @copyright{} 1999, 2000 Free Software Foundation, Inc. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
87 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
88 Permission is granted to make and distribute verbatim copies of this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
89 manual provided the copyright notice and this permission notice are |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
90 preserved on all copies. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
91 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
92 Permission is granted to copy and distribute modified versions of this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
93 manual under the conditions for verbatim copying, provided also that the |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
94 section entitled ``GNU General Public License'' is included exactly as |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
95 in the original, and provided that the entire resulting derived work is |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
96 distributed under the terms of a permission notice identical to this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
97 one. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
98 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
99 Permission is granted to copy and distribute translations of this manual |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
100 into another language, under the above conditions for modified versions, |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
101 except that the section entitled ``GNU General Public License'' and this |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
102 permission notice may be included in translations approved by the Free |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
103 Software Foundation instead of in the original English. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
104 @end titlepage |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
105 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
106 @contents |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
107 |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
108 @c ================================================================ |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
109 @c The real text starts here |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
110 @c ================================================================ |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
111 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
112 @node Top, What is Eshell?, (dir), (dir) |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
113 @ifinfo |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
114 @top Eshell |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
115 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
116 This manual documents Eshell, a shell-like command interpretor |
33020 | 117 implemented in Emacs Lisp. It invokes no external processes except for |
118 those requested by the user. It is intended to be a functional | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
119 replacement for command shells such as @command{bash}, @command{zsh}, |
33020 | 120 @command{rc}, or @command{4dos}; since Emacs itself is capable of |
121 handling the sort of tasks accomplished by those tools. | |
122 @c This manual is updated to release 2.4 of Eshell. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
123 @end ifinfo |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
124 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
125 @menu |
33020 | 126 * What is Eshell?:: A brief introduction to the Emacs Shell. |
127 * Installation:: For users of Emacs 20 and XEmacs. | |
128 * Command basics:: The basics of command usage. | |
129 * Bugs and ideas:: Known problems, and future ideas. | |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
130 * Concept Index:: |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
131 * Function and Variable Index:: |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
132 * Key Index:: |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
133 @end menu |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
134 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
135 @node What is Eshell?, Installation, Top, Top |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
136 @chapter What is Eshell? |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
137 @cindex what is Eshell? |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
138 @cindex Eshell, what it is |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
139 |
33020 | 140 Eshell is a @dfn{command shell} written in Emacs Lisp. Everything it |
141 does it uses Emacs' facilities to do. This means that Eshell is as | |
142 portable as Emacs itself. It also means that cooperation with Lisp code | |
143 is natural and seamless. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
144 |
33020 | 145 What is a command shell? To properly understand the role of a shell, |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
146 it's necessary to visualize what a computer does for you. Basically, a |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
147 computer is a tool; in order to use that tool, you must tell it what to |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
148 do---or give it ``commands''. These commands take many forms, such as |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
149 clicking with a mouse on certain parts of the screen. But that is only |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
150 one form of command input. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
151 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
152 By far the most versatile way to express what you want the computer to |
33020 | 153 do is by using an abbreviated language called @dfn{script}. In script, |
154 instead of telling the computer, ``list my files, please'', one writes | |
155 just ``list''. In fact, this command is so commonly used that it is | |
156 abbreviated to ``ls''. Typing @kbd{ls} in a command shell is a script | |
157 way of telling the computer to list your files.@footnote{This is | |
158 comparable to viewing the contents of a folder using a graphical | |
159 display.} | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
160 |
33020 | 161 The real flexibility of this approach is apparent only when you realize |
162 that there are many, many different ways to list files. Perhaps you | |
163 want them sorted by name, sorted by date, in reverse order, or grouped | |
164 by type. Most graphical browsers have simple ways to express this. But | |
165 what about showing only a few files, or only files that meet a certain | |
166 criteria? In very complex and specific situations, the request becomes | |
167 too difficult to express using a mouse or pointing device. It is just | |
168 these kinds of requests that are easily solved using a command shell. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
169 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
170 For example, what if you want to list every Word file on your hard |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
171 drive, larger than 100 kilobytes in size, and which hasn't been looked |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
172 at in over six months? That is a good candidate list for deletion, when |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
173 you go to clean up your hard drive. But have you ever tried asking your |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
174 computer for such a list? There is no way to do it! At least, not |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
175 without using a command shell. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
176 |
33020 | 177 The role of a command shell is to give you more control over what your |
178 computer does for you. Not everyone needs this amount of control, and | |
179 it does come at a cost: Learning the necessary script commands to | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
180 express what you want done. A complicated query, such as the example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
181 above, takes time to learn. But if you find yourself using your |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
182 computer frequently enough, it is more than worthwhile in the long run. |
33020 | 183 Any tool you use often deserves the time spent learning to master it. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
184 @footnote{For the understandably curious, here is what that command |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
185 looks like: But don't let it fool you; once you know what's going on, |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
186 it's easier than it looks: @code{ls -lt **/*.doc(Lk+50aM+5)}.} |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
187 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
188 As of Emacs 21, Eshell is part of the standard Emacs distribution. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
189 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
190 @menu |
33020 | 191 * Contributors to Eshell:: People who have helped out! |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
192 @end menu |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
193 |
33020 | 194 @node Contributors to Eshell, , What is Eshell?, What is Eshell? |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
195 @section Contributors to Eshell |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
196 @cindex contributors |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
197 @cindex authors |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
198 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
199 Contributions to Eshell are welcome. I have limited time to work on |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
200 this project, but I will gladly add any code you contribute to me to |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
201 this package. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
202 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
203 The following persons have made contributions to Eshell. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
204 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
205 @itemize @bullet |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
206 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
207 Eli Zaretskii made it possible for Eshell to run without requiring |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
208 asynchronous subprocess support. This is important for MS-DOS, which |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
209 does not have such support.@refill |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
210 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
211 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
212 Miles Bader contributed many fixes during the port to Emacs 21.@refill |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
213 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
214 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
215 Stefan Monnier fixed the things which bothered him, which of course made |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
216 things better for all.@refill |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
217 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
218 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
219 Gerd Moellmann also helped to contribute bug fixes during the initial |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
220 integration with Emacs 21.@refill |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
221 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
222 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
223 Alex Schroeder contributed code for interactively querying the user |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
224 before overwriting files.@refill |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
225 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
226 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
227 Sudish Joseph helped with some XEmacs compatibility issues.@refill |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
228 @end itemize |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
229 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
230 Apart from these, a lot of people have sent suggestions, ideas, |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
231 requests, bug reports and encouragement. Thanks a lot! Without you |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
232 there would be no new releases of Eshell. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
233 |
33020 | 234 @node Installation, Command basics, What is Eshell?, Top |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
235 @chapter Installation |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
236 @cindex installation |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
237 |
33020 | 238 As mentioned above, Eshell comes preinstalled as of Emacs 21. If you're |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
239 using Emacs 20.4 or later, or XEmacs 21, you can download the most |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
240 recent version of Eshell from |
32451
b09ded79f0f9
Removed all external URL references, and changed one, since my
John Wiegley <johnw@newartisans.com>
parents:
32450
diff
changeset
|
241 @url{http://www.gci-net.com/users/j/johnw/Emacs/eshell.tar.gz}. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
242 |
33020 | 243 However, if you are using Emacs 21, you may skip this section. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
244 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
245 @section Short Form |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
246 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
247 Here's exactly what to do, with no explanation why: |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
248 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
249 @enumerate |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
250 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
251 @samp{M-x load-file RET eshell-auto.el RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
252 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
253 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
254 @samp{ESC : (add-to-list 'load-path "<path where Eshell resides>") RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
255 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
256 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
257 @samp{ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
258 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
259 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
260 @samp{M-x eshell RET}. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
261 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
262 You should see a version banner displayed. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
263 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
264 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
265 @samp{ls RET}. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
266 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
267 Confirm that you see a file listing. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
268 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
269 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
270 @samp{eshell-test RET}. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
271 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
272 Confirm that everything runs correctly. Use @kbd{M-x eshell-report-bug} if |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
273 not. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
274 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
275 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
276 @samp{cd $@{dirname (locate-library "eshell-auto")@} RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
277 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
278 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
279 @samp{find-file Makefile RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
280 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
281 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
282 Edit the Makefile to reflect your site. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
283 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
284 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
285 @samp{M-x eshell RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
286 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
287 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
288 @samp{make install RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
289 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
290 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
291 @samp{find-file $user-init-file RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
292 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
293 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
294 Add the following lines to your @file{.emacs} file: |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
295 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
296 @example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
297 (add-to-list 'load-path "<directory where you install Eshell>") |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
298 (load "eshell-auto") |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
299 @end example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
300 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
301 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
302 @samp{M-x eshell RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
303 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
304 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
305 @samp{customize-option #'eshell-modules-list RET}. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
306 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
307 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
308 Select the extension modules you prefer. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
309 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
310 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
311 Restart Emacs! |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
312 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
313 @item |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
314 @samp{M-x info RET m Eshell RET}. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
315 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
316 Read the manual and enjoy! |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
317 @end enumerate |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
318 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
319 @section Long Form |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
320 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
321 @enumerate |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
322 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
323 Before building and installing Eshell, it is important to test that it |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
324 will work properly on your system. To do this, first load the file |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
325 @file{eshell-auto}, which will define certain autoloads required to run |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
326 Eshell. This can be done using the command @kbd{M-x load-file}, and |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
327 then selecting the file @file{eshell-auto.el}. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
328 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
329 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
330 In order for Emacs to find Eshell's files, the Eshell directory must be |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
331 added to the @code{load-path} variable. This can be done within Emacs by |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
332 typing: |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
333 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
334 @example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
335 ESC : (add-to-list 'load-path "<path where Eshell resides>") RET |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
336 ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
337 @end example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
338 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
339 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
340 Start Eshell from the distributed sources, using default settings, by |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
341 typing @kbd{M-x eshell}. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
342 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
343 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
344 Verify that Eshell is functional by typing @command{ls} followed by |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
345 @key{RET}. You should have already seen a version banner announcing the |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
346 version number of this release, followed by a prompt. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
347 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
348 @item |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
349 Run the test suite by typing @command{eshell-test} followed by @key{RET} |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
350 in the Eshell buffer. It is important that Emacs be left alone while |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
351 the tests are running, since extraneous command input may cause some of |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
352 the tests to fail (they were never intended to run in the background). |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
353 If all of the tests pass, Eshell should work just fine on your system. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
354 If any of the tests fail, please send e-mail to the Eshell maintainer |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
355 using the command @kbd{M-x eshell-report-bug}. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
356 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
357 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
358 Edit the file @file{Makefile} in the directory containing the Eshell |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
359 sources to reflect the location of certain Emacs dircetories at your |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
360 site. The only things you really have to change are the definitions of |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
361 @code{lispdir} and @code{infodir}. The elisp files will be copied to |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
362 @code{lispdir}, and the info file to @code{infodir}. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
363 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
364 @item |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
365 Type @kbd{make install} in the directory containing the Eshell sources. |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
366 This will byte-compile all of the @file{*.el} files and copy both the |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
367 source and compiled versions to the directories specified in the |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
368 previous step. It will also copy the info file, and add a corresponding |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
369 entry to your @file{dir} file----if the program @code{install-info} can |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
370 be found on your system. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
371 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
372 If you only want to create the compiled elisp files, but don't want to |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
373 install them, you can type just @kbd{make} instead. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
374 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
375 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
376 Add the directory into which Eshell was installed to your |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
377 @code{load-path} variable. This can be done by adding the following |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
378 line to your @file{.emacs} file: |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
379 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
380 @example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
381 (add-to-list 'load-path "/usr/local/share/emacs/site-lisp/eshell") |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
382 @end example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
383 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
384 The actual directory on your system may differ. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
385 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
386 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
387 To install Eshell privately, edit your @file{.emacs} file; to install |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
388 Eshell site-wide, edit the file @file{site-start.el} in your |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
389 @file{site-lisp} directory (usually |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
390 @file{/usr/local/share/emacs/site-lisp} or something similar). In |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
391 either case enter the following line into the appropriate file: |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
392 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
393 @example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
394 (load "eshell-auto") |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
395 @end example |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
396 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
397 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
398 Restart Emacs. After restarting, customize the variable |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
399 @code{eshell-modules-list}. This variable selects which Eshell |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
400 extension modules you want to use. You will find documentation on each |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
401 of those modules in the Info manual. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
402 @end enumerate |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
403 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
404 @cindex documentation, printed version |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
405 @cindex printed version of documentation |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
406 If you have @TeX{} installed at your site, you can make a typeset manual |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
407 from @file{eshell.texi}. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
408 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
409 @enumerate |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
410 @item |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
411 Run @TeX{} by typing @kbd{texi2dvi eshell.texi}. (With Emacs 21.1 or |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
412 later, typing @kbd{make eshell.dvi} in the @file{man/} subdirectory of |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
413 the Emacs source distribution will do that.) |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
414 |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
415 @item |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
416 Convert the resulting device independent file @file{eshell.dvi} to a |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
417 form which your printer can output and print it. If you have a |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
418 postscript printer, there is a program, @code{dvi2ps}, which does that; there |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
419 is also a program which comes together with @TeX{}, @code{dvips}, which |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
420 you can use. For other printers, use a suitable DVI driver, |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
421 e.g., @code{dvilj4} for LaserJet-compatible printers. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
422 @end enumerate |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
423 |
33020 | 424 @node Command basics, Bugs and ideas, Installation, Top |
425 @chapter Command basics | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
426 |
33020 | 427 A command shell is a mechanism for entering verbally-formed commands. |
428 This is really all that it does, and every feature described in this | |
429 manual is a means to that end. Therefore, it's important to get a firm | |
430 grasp on exactly what a command is, and how it fits into the overall | |
431 picture of things. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
432 |
33020 | 433 @menu |
434 * Commands verbs:: Commands always begin with a verb. | |
435 * Command arguments:: Some verbs require arguments. | |
436 @end menu | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
437 |
33020 | 438 @node Commands verbs, Command arguments, Command basics, Command basics |
439 @section Commands verbs | |
440 | |
441 Commands are expressed using @dfn{script}, a special shorthand language | |
442 that computers can understand without trouble. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
443 |
33020 | 444 Script is an extremely simplified language. Oddly enough, this actually |
445 makes it look more complicated than it is. Whereas normal languages use | |
446 a variety of embellishments, the form of a script command is always: | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
447 |
33020 | 448 @example |
449 VERB [ARGUMENTS] | |
450 @end example | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
451 |
33020 | 452 The verb expresses what you want your computer to do. There are a fixed |
453 number of verbs, although this number is usually quite large. On the | |
454 author's computer, it reaches almost 1400 in number. But of course, | |
455 only a handful of these are really necessary. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
456 |
33020 | 457 Sometimes, the verb is all that's written. A verb is always a single |
458 word, usually related to the task it will perform. @command{reboot} is | |
459 a good example. Entering that will cause your computer to reboot, | |
460 assuming you have sufficient privileges. | |
461 | |
462 Other verbs require more information. These are usually very capable of | |
463 verbs, and must be told more specifically what to do. This extra | |
464 information is given in the form of arguments. Arguments are also | |
465 single words, that appear after the verb. For example, @command{echo} | |
466 is a command verb that prints back whatever you say. @command{echo} | |
467 requires arguments, so that it knows what to echo. A proper use of | |
468 @command{echo} looks like this: | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
469 |
33020 | 470 @example |
471 echo This is an example of using echo! | |
472 @end example | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
473 |
33020 | 474 This piece of script expresses a command that causes the computer to |
475 print back: ``This is an example of using echo!''. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
476 |
33020 | 477 Although command verbs always take the form of simple words, such as |
478 @command{reboot} and @command{echo}, arguments have a wide vaierty of | |
479 forms. There are textual arguments, numerical arguments---even Lisp | |
480 arguments. Distinguishing between these different types of arguments | |
481 requires special typing, since the computer needs to know exactly what | |
482 you mean. | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
483 |
33020 | 484 @node Command arguments, , Commands verbs, Command basics |
485 @section Command arguments | |
486 | |
487 @node Bugs and ideas, Concept Index, Command basics, Top | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
488 @chapter Bugs and ideas |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
489 @cindex reporting bugs and ideas |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
490 @cindex bugs, how to report them |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
491 @cindex author, how to reach |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
492 @cindex email to the author |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
493 @cindex FAQ |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
494 @cindex problems, list of common |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
495 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
496 If you find a bug or misfeature, don't hesitate to let me know! Send |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
497 email to @email{johnw@@gnu.org}. Feature requests should also be sent |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
498 there. I prefer discussing one thing at a time. If you find several |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
499 unrelated bugs, please report them separately. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
500 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
501 If you have ideas for improvements, or if you have written some |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
502 extensions to this package, I would like to hear from you. I hope you |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
503 find this package useful! |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
504 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
505 @menu |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
506 * Known problems:: |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
507 @end menu |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
508 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
509 @node Known problems, , Bugs and ideas, Bugs and ideas |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
510 @section Known problems |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
511 @cindex known bugs |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
512 @cindex bugs, known |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
513 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
514 Below is a partial list of currently known problems with Eshell version |
33020 | 515 2.4, which is the version distributed with Emacs 21.1. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
516 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
517 @table @asis |
33020 | 518 @item Differentiate between aliases and functions |
519 | |
520 Allow for a bash-compatible syntax, such as: | |
521 | |
522 @example | |
523 alias arg=blah | |
33022
4c98dfd09341
Corrected some typos
John Wiegley <johnw@newartisans.com>
parents:
33020
diff
changeset
|
524 function arg () @{ blah $* @} |
33020 | 525 @end example |
526 | |
527 @item @samp{for i in 1 2 3 @{ grep -q a b && *echo has it @} | wc -l} outputs result after prompt | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
528 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
529 In fact, piping to a process from a looping construct doesn't work in |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
530 general. If I change the call to @code{eshell-copy-handles} in |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
531 @code{eshell-rewrite-for-command} to use @code{eshell-protect}, it seems |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
532 to work, but the output occurs after the prompt is displayed. The whole |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
533 structured command thing is too complicated at present. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
534 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
535 @item Error with @command{bc} in @code{eshell-test} |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
536 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
537 On some XEmacs system, the subprocess interaction test fails |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
538 inexplicably, although @command{bc} works fine at the command prompt. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
539 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
540 @item Eshell does not delete @file{*Help*} buffers in XEmacs 21.1.8+ |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
541 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
542 In XEmacs 21.1.8, the @file{*Help*} buffer has been renamed such that |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
543 multiple instances of the @file{*Help*} buffer can exist. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
544 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
545 @item Pcomplete sometimes gets stuck |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
546 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
547 You press @key{TAB}, but no completions appear, even though the |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
548 directory has matching files. This behavior is rare. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
549 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
550 @item @samp{grep python $<rpm -qa>} doesn't work, but using @samp{*grep} does |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
551 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
552 This happens because the @code{grep} Lisp function returns immediately, |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
553 and then the asynchronous @command{grep} process expects to examine the |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
554 temporary file, which has since been deleted. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
555 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
556 @item Problem with C-r repeating text |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
557 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
558 If the text @emph{before point} reads "./run", and you type @kbd{C-r r u |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
559 n}, it will repeat the line for every character typed. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
560 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
561 @item Backspace doesn't scroll back after continuing (in smart mode) |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
562 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
563 Hitting space during a process invocation, such as @command{make}, will |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
564 cause it to track the bottom of the output; but backspace no longer |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
565 scrolls back. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
566 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
567 @item It's not possible to fully @code{unload-feature} Eshell |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
568 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
569 @item Menu support was removed, but never put back |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
570 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
571 @item Using C-p and C-n with rebind gets into a locked state |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
572 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
573 This happened a few times in Emacs 21, but has been unreproducable |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
574 since. |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
575 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
576 @item If an interactive process is currently running, @kbd{M-!} doesn't work |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
577 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
578 @item Use a timer instead of @code{sleep-for} when killing child processes |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
579 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
580 @item Piping to a Lisp function is not supported |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
581 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
582 Make it so that the Lisp command on the right of the pipe is repeatedly |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
583 called with the input strings as arguments. This will require changing |
33020 | 584 @code{eshell-do-pipeline} to handle non-process targets. |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
585 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
586 @item Input redirection is not supported |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
587 |
33020 | 588 See the above entry. |
589 | |
590 @item Problem running @command{less} without argument on Windows | |
591 | |
592 The result in the Eshell buffer is: | |
593 | |
594 @example | |
595 Spawning child process: invalid argument | |
596 @end example | |
597 | |
598 Also a new @command{less} buffer was created with nothing in it@dots{} | |
599 (presumably this holds the output of @command{less}). | |
600 | |
601 If @command{less.exe} is invoked from the Eshell command line, the | |
602 expected output is written to the buffer. | |
603 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
604 Note that this happens on NT-Emacs 20.6.1 on Windows 2000. The term.el |
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
605 package and the supplied shell both use the @command{cmdproxy} program |
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
606 for running shells. |
33020 | 607 |
608 @item Implement @samp{-r}, @samp{-n} and @samp{-s} switches for @command{cp} | |
609 | |
610 @item Make @kbd{M-5 M-x eshell} switch to ``*eshell<5>*'', creating if need be | |
611 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
612 @item @samp{mv @var{dir} @var{file}.tar} does not remove directories |
33020 | 613 |
614 This is because the tar option --remove-files doesn't do so. Should it | |
615 be Eshell's job? | |
616 | |
617 @item Bind @code{standard-output} and @code{standard-error} | |
618 | |
619 This would be so that if a Lisp function calls @code{print}, everything | |
620 will happen as it should (albeit slowly). | |
621 | |
622 @item When an extension module fails to load, @samp{cd /} gives a Lisp error | |
623 | |
624 @item If a globbing pattern returns one match, should it be a list? | |
625 | |
626 @item Make sure syntax table is correct in Eshell mode | |
627 | |
628 So that @kbd{M-DEL} acts in a predictable manner, etc. | |
629 | |
630 @item Allow all Eshell buffers to share the same history and list-dir | |
631 | |
632 @item There is a problem with script commands that output to @file{/dev/null} | |
633 | |
634 If a script file, somewhere in the middle, uses @samp{> /dev/null}, | |
635 output from all subsequent commands is swallowed. | |
636 | |
637 @item Split up parsing of text after @samp{$} in @file{esh-var.el} | |
638 | |
639 Make it similar to the way that @file{esh-arg.el} is structured. | |
640 Then add parsing of @samp{$[?\n]}. | |
641 | |
642 @item After pressing @kbd{M-RET}, redisplay before running the next command | |
643 | |
644 @item Argument predicates and modifiers should work anywhere in a path | |
645 | |
646 @example | |
647 /usr/local/src/editors/vim $ vi **/CVS(/)/Root(.) | |
648 Invalid regexp: "Unmatched ( or \\(" | |
649 @end example | |
650 | |
651 With @command{zsh}, the glob above expands to all files named | |
652 @file{Root} in directories named @file{CVS}. | |
653 | |
33022
4c98dfd09341
Corrected some typos
John Wiegley <johnw@newartisans.com>
parents:
33020
diff
changeset
|
654 @item Typing @samp{echo $@{locate locate@}/bin<TAB>} results in a Lisp error |
33020 | 655 |
656 Perhaps it should interpolate all permutations, and make that the | |
657 globbing result, since otherwise hitting return here will result in | |
658 ``(list of filenames)/bin'', which is never valuable. Thus, one could | |
33022
4c98dfd09341
Corrected some typos
John Wiegley <johnw@newartisans.com>
parents:
33020
diff
changeset
|
659 @command{cat} only C backup files by using @samp{ls $@{identity *.c@}~}. |
33020 | 660 In that case, having an alias command name @command{glob} for |
661 @command{identity} would be useful. | |
662 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
663 @item Fix `file-name-all-completions' for XEmacs on MS-Windows |
33020 | 664 |
665 Make sure it returns directory names terminated by | |
666 @code{directory-sep-char} (which is initialized to be @samp{?/}), rather | |
667 than backslash. | |
668 | |
669 @item Once symbolic mode is supported for @command{umask}, implement @command{chmod} in Lisp | |
670 | |
671 @item Create @code{eshell-expand-file-name} | |
672 | |
673 This would use a data table to transform things such as @samp{~+}, | |
674 @samp{...}, etc. | |
675 | |
676 @item Abstract @file{em-smart.el} into @file{smart-scroll.el} | |
677 | |
678 It only really needs: to be hooked onto the output filter and the | |
679 pre-command hook, and to have the input-end and input-start markers. | |
680 And to know whether the last output group was ``successful''. | |
681 | |
682 @item Allow for fully persisting the state of Eshell | |
683 | |
684 This would include: variables, history, buffer, input, dir stack, etc. | |
685 | |
686 @item Implement D as an argument predicate | |
687 | |
688 It means that files beginning with a dot should be included in the | |
689 glob match. | |
690 | |
691 @item A comma in a predicate list should mean OR | |
692 | |
693 At the moment, this is not supported. | |
694 | |
695 @item Error if a glob doesn't expand due to a predicate | |
696 | |
697 An error should be generated only if @code{eshell-error-if-no-glob} is | |
698 non-nil. | |
699 | |
700 @item @samp{(+ RET SPC TAB} does not cause @code{indent-according-to-mode} to occur | |
701 | |
702 @item Create @code{eshell-auto-accumulate-list} | |
703 | |
704 This is a list of commands for which, if the user presses @kbd{RET}, the | |
705 text is staged as the next Eshell command, rather than being sent to the | |
706 current interactive process. | |
707 | |
708 @item Display file and line number if an error occurs in a script | |
709 | |
710 @item @command{wait} doesn't work with process ids at the moment | |
711 | |
712 @item Enable the direct-to-process input code in @file{em-term.el} | |
713 | |
714 @item Problem with repeating @samp{echo $@{find /tmp@}} | |
715 | |
716 With smart display active, if @kbd{RET} is held down, after a while it | |
717 can't keep up anymore and starts outputting blank lines. It only | |
718 happens if an asynchronous process is involved@dots{} | |
719 | |
720 I think the problem is that @code{eshell-send-input} is resetting the | |
721 input target location, so that if the asynchronous process is not done | |
722 by the time the next @kbd{RET} is received, the input processor thinks | |
723 that the input is meant for the process; which, when smart display is | |
724 enabled, will be the text of the last command line! That is a bug in | |
725 itself. | |
726 | |
727 In holding down @kbd{RET} while an asynchronous process is running, | |
728 there will be a point in between termination of the process, and the | |
729 running of @code{eshell-post-command-hook}, which would cause | |
730 @code{eshell-send-input} to call @code{eshell-copy-old-input}, and then | |
731 process that text as a command to be run after the process. Perhaps | |
732 there should be a way of killing pending input between the death of the | |
733 process, and the @code{post-command-hook}. | |
734 | |
735 @item Allow for a more aggressive smart display mode | |
736 | |
737 Perhaps toggled by a command, that makes each output block a smart | |
738 display block. | |
739 | |
740 @item Create more meta variables | |
741 | |
742 @table @samp | |
743 @item $! | |
744 The reason for the failure of the last disk command, or the text of the | |
745 last Lisp error. | |
746 | |
747 @item $= | |
748 A special associate array, which can take references of the form | |
749 @samp{$=[REGEXP]}. It indexes into the directory ring. | |
750 @end table | |
751 | |
752 @item Eshell scripts can't execute in the background | |
753 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
754 @item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}} |
33020 | 755 |
756 @item Write an @command{info} alias that can take arguments | |
757 | |
758 So that the user can enter @samp{info chmod}, for example. | |
759 | |
760 @item Create a mode @code{eshell-browse} | |
761 | |
762 It would treat the Eshell buffer as a outline. Collapsing the outline | |
763 hides all of the output text. Collapsing again would show only the | |
764 first command run in each directory | |
765 | |
766 @item Allow other revisions of a file to be referenced using @samp{file@{rev@}} | |
767 | |
768 This would be expanded by @code{eshell-expand-file-name} (see above). | |
769 | |
770 @item Print ``You have new mail'' when the ``Mail'' icon is turned on | |
771 | |
772 @item Implement @kbd{M-|} for Eshell | |
773 | |
774 @item Implement input redirection | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
775 |
33020 | 776 If it's a Lisp function, input redirection implies @command{xargs} (in a |
777 way@dots{}). If input redirection is added, also update the | |
778 @code{file-name-quote-list}, and the delimiter list. | |
779 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
780 @item Allow @samp{#<@var{word} @var{arg}>} as a generic syntax |
33020 | 781 |
782 With the handling of @emph{word} specified by an | |
783 @code{eshell-special-alist}. | |
784 | |
785 @item In @code{eshell-eval-using-options}, allow a @code{:complete} tag | |
786 | |
787 It would be used to provide completion rules for that command. Then the | |
788 macro will automagically define the completion function. | |
789 | |
790 @item For @code{eshell-command-on-region}, apply redirections to the result | |
791 | |
792 So that @samp{+ > 'blah} would cause the result of the @code{+} (using | |
793 input from the current region) to be inserting into the symbol | |
794 @code{blah}. | |
795 | |
796 If an external command is being invoked, the input is sent as standard | |
797 input, as if a @samp{cat <region> |} had been invoked. | |
798 | |
799 If a Lisp command, or an alias, is invoked, then if the line has no | |
800 newline characters, it is divided by whitespace and passed as arguments | |
801 to the Lisp function. Otherwise, it is divided at the newline | |
802 characters. Thus, invoking @code{+} on a series of numbers will add | |
803 them; @code{min} would display the smallest figure, etc. | |
804 | |
805 @item Write @code{eshell-script-mode} as a minor mode | |
806 | |
807 It would provide syntax, abbrev, highlighting and indenting support like | |
808 @code{emacs-lisp-mode} and @code{shell-mode}. | |
809 | |
810 @item In the history mechanism, finish the @command{bash}-style support | |
811 | |
812 This means @samp{!n}, @samp{!#}, @samp{!:%}, and @samp{!:1-} as separate | |
813 from @samp{!:1*}. | |
814 | |
815 @item Support the -n command line option for @command{history} | |
816 | |
817 @item Implement @command{fc} in Lisp | |
818 | |
819 @item Specifying a frame as a redirection target should imply the currently active window's buffer | |
820 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
821 @item Implement @samp{>@var{func-or-func-list}} |
33020 | 822 |
823 This would allow for an ``output translators'', that take a function to | |
824 modify output with, and a target. Devise a syntax that works well with | |
825 pipes, and can accomodate multiple functions (i.e., @samp{>'(upcase | |
826 regexp-quote)} or @samp{>'upcase}). | |
827 | |
828 @item Allow Eshell to read/write to/from standard input and output | |
829 | |
830 This would be optional, rather than always using the Eshell buffer. | |
831 This would allow it to be run from the command line (perhaps). | |
832 | |
833 @item Write a @command{help} command | |
834 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
835 It would call subcommands with @option{--help}, or @option{-h} or |
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
836 @option{/?}, as appropriate. |
33020 | 837 |
838 @item Implement @command{stty} in Lisp | |
839 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
840 @item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}} |
33020 | 841 |
842 @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list} | |
843 | |
844 Using @command{bg} on a process that is already in the background does | |
845 nothing. Specifying redirection targets replaces (or adds) to the list | |
846 current being used. | |
847 | |
848 @item Have @command{jobs} print only the processes for the current shell | |
849 | |
850 @item How can Eshell learn if a background process has requested input? | |
851 | |
852 @item Support @samp{2>&1} and @samp{>&} and @samp{2>} and @samp{|&} | |
853 | |
854 The syntax table for parsing these should be customizable, such that the | |
855 user could change it to use rc syntax: @samp{>[2=1]}. | |
856 | |
857 @item Allow @samp{$_[-1]}, which would indicate the last element of the array | |
858 | |
859 @item Make @samp{$x[*]} equal to listing out the full contents of @samp{x} | |
860 | |
861 Return them as a list, so that @samp{$_[*]} is all the arguments of the | |
862 last command. | |
863 | |
864 @item Copy ANSI code handling from @file{term.el} into @file{em-term.el} | |
865 | |
866 Make it possible for the user to send char-by-char to the underlying | |
867 process. Ultimately, I should be able to move away from using term.el | |
868 altogether, since everything but the ANSI code handling is already part | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
869 of Eshell. Then, things would work correctly on MS-Windows as well |
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
870 (which doesn't have @file{/bin/sh}, although @file{term.el} tries to use |
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
871 it). |
33020 | 872 |
873 @item Make the shell spawning commands be visual | |
874 | |
875 That is, make (@command{su}, @command{bash}, @command{telnet}, | |
876 @command{rlogin}, @command{rsh}, etc.) be part of | |
877 @code{eshell-visual-commands}. The only exception is if the shell is | |
878 being used to invoke a single command. Then, the behavior should be | |
879 based on what that command is. | |
880 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
881 @item Create a smart viewing command named @command{open} |
33020 | 882 |
883 This would search for some way to open its argument (similar to opening | |
884 a file in the Windows Explorer). | |
885 | |
886 @item Alias @command{read} to be the same as @command{open}, only read-only | |
887 | |
888 @item Write a @command{tail} command which uses @code{view-file} | |
889 | |
890 It would move point to the end of the buffer, and then turns on | |
891 auto-revert mode in that buffer at frequent intervals---and a | |
892 @command{head} alias which assums an upper limit of | |
893 @code{eshell-maximum-line-length} characters per line. | |
894 | |
895 @item Make @command{dgrep} load @code{dired}, mark everything, then invoke @code{dired-do-search} | |
896 | |
897 @item Write emsh.c | |
898 | |
899 This would run Emacs with the appropriate arguments to invoke Eshell | |
900 only. That way, it could be listed as a login shell. | |
901 | |
902 @item Use an intangible @code{PS2} string for multi-line input prompts | |
903 | |
904 @item Auto-detect when a command is visual, by checking @code{TERMCAP} usage | |
905 | |
906 @item The first keypress after @kbd{M-x watson} triggers `eshell-send-input' | |
907 | |
908 @item Make @kbd{/} electric | |
909 | |
910 So that it automatically expands and corrects pathnames. Or make | |
911 pathname completion for Pcomplete auto-expand @samp{/u/i/std<TAB>} to | |
912 @samp{/usr/include/std<TAB>}. | |
913 | |
914 @item Write the @command{pushd} stack to disk along with @code{last-dir-ring} | |
915 | |
916 @item Add options to @code{eshell/cat} which would allow it to sort and uniq | |
917 | |
918 @item Implement @command{wc} in Lisp | |
919 | |
920 Add support for counting sentences, paragraphs, pages, etc. | |
921 | |
922 @item Once piping is added, implement @command{sort} and @command{uniq} in Lisp | |
923 | |
924 @item Implement @command{touch} in Lisp | |
925 | |
926 @item Implement @command{comm} in Lisp | |
927 | |
928 @item Implement an @command{epatch} command in Lisp | |
929 | |
930 This would call @code{ediff-patch-file}, or @code{ediff-patch-buffer}, | |
931 depending on its argument. | |
932 | |
933 @item Have an option such that @samp{ls -l} generates a dired buffer | |
934 | |
935 @item Write a version of @command{xargs} based on command rewriting | |
936 | |
937 That is, @samp{find X | xargs Y} would be indicated using @samp{Y | |
938 $@{find X@}}. Maybe @code{eshell-do-pipelines} could be changed to | |
939 perform this on-thy-fly rewriting. | |
940 | |
941 @item Write an alias for @command{less} that brings up a @code{view-mode} buffer | |
942 | |
33030
867e27924dcd
Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents:
33022
diff
changeset
|
943 Such that the user can press @key{SPC} and @key{DEL}, and then @key{q} |
33020 | 944 to return to Eshell. It would be equivalent to: |
945 @samp{X > #<buffer Y>; view-buffer #<buffer Y>}. | |
946 | |
947 @item Make @code{eshell-mode} as much a full citizen as @code{shell-mode} | |
948 | |
949 Everywhere in Emacs where @code{shell-mode} is specially noticed, add | |
950 @code{eshell-mode} there. | |
951 | |
952 @item Permit the umask to be selectively set on a @command{cp} target | |
953 | |
954 @item Problem using @kbd{M-x eshell} after using @code{eshell-command} | |
955 | |
956 If the first thing that I do after entering Emacs is to run | |
957 @code{eshell-command} and invoke @command{ls}, and then use @kbd{M-x | |
958 eshell}, it doesn't display anything. | |
959 | |
960 @item @kbd{M-RET} during a long command (using smart display) doesn't work | |
961 | |
962 Since it keeps the cursor up where the command was invoked. | |
963 | |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
964 @end table |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
965 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
966 @node Concept Index, Function and Variable Index, Bugs and ideas, Top |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
967 @unnumbered Concept Index |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
968 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
969 @printindex cp |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
970 |
32542
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
971 @node Function and Variable Index, Key Index, Concept Index, Top |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
972 @unnumbered Function and Variable Index |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
973 |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
974 @printindex fn |
9b4c05d377c9
Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents:
32451
diff
changeset
|
975 |
33020 | 976 @node Key Index, , Function and Variable Index, Top |
32450
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
977 @unnumbered Key Index |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
978 |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
979 @printindex ky |
99899af1ec94
Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff
changeset
|
980 @bye |