annotate man/eshell.texi @ 57886:60d07d8a52e1

* url-imap.el (url-imap-open-host): Don't use `string-to-int'. The port returned by `url-port' is expected to be an integer. * url-irc.el (url-irc): Ditto. * url-news.el (url-news-open-host): Ditto. * url-nfs.el (url-nfs-build-filename): Ditto.
author Masatake YAMATO <jet@gyve.org>
date Tue, 02 Nov 2004 09:40:30 +0000
parents b1ae5333057a
children bc3006550677 e8df1878cfd1 59dcbfe97385
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 @c %**start of header
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
3 @setfilename ../info/eshell
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
4 @settitle Eshell: The Emacs Shell
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
5 @synindex vr fn
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
6 @c %**end of header
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
7
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
8 @copying
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
9 This manual is for Eshell, the Emacs shell.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
10
54836
746c40973d25 Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-210
Miles Bader <miles@gnu.org>
parents: 53171
diff changeset
11 Copyright @copyright{} 1999, 2000, 2001, 2002, 2004 Free Software Foundation, Inc.
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
12
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
13 @quotation
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
14 Permission is granted to copy, distribute and/or modify this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
15 under the terms of the GNU Free Documentation License, Version 1.1 or
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
16 any later version published by the Free Software Foundation; with no
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
17 Invariant Sections, with the Front-Cover texts being ``A GNU
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
18 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
19 license is included in the section entitled ``GNU Free Documentation
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
20 License'' in the Emacs manual.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
21
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
22 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
23 this GNU Manual, like GNU software. Copies published by the Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
24 Software Foundation raise funds for GNU development.''
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
25
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
26 This document is part of a collection distributed under the GNU Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
27 Documentation License. If you want to distribute this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
28 separately from the collection, you can do so by adding a copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37283
diff changeset
29 license to the document, as described in section 6 of the license.
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
30 @end quotation
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
31 @end copying
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
32
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
33 @dircategory Emacs
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
34 @direntry
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
35 * Eshell: (eshell). A command shell implemented in Emacs Lisp.
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
36 @end direntry
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
37
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
38 @setchapternewpage on
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
39
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
40 @titlepage
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
41 @sp 4
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
42 @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
43 @center @titlefont{User's Guide}
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
44 @sp
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
45 @center @titlefont{to}
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
46 @sp
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
47 @center @titlefont{Eshell: The Emacs Shell}
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
48 @ignore
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
49 @sp 2
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
50 @center release 2.4
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
51 @c -release-
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
52 @end ignore
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
53 @sp 3
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
54 @center John Wiegley
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
55 @c -date-
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
56
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
57 @page
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
58 @vskip 0pt plus 1filll
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
59 @insertcopying
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
60 @end titlepage
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
61
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
62 @contents
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
63
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
64 @c ================================================================
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
65 @c The real text starts here
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
66 @c ================================================================
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
67
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
68 @ifnottex
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
69 @node Top, What is Eshell?, (dir), (dir)
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
70 @top Eshell
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
71
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
72 This manual documents Eshell, a shell-like command interpretor
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
73 implemented in Emacs Lisp. It invokes no external processes except for
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
74 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
75 replacement for command shells such as @command{bash}, @command{zsh},
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
76 @command{rc}, or @command{4dos}; since Emacs itself is capable of
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
77 handling the sort of tasks accomplished by those tools.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
78 @c This manual is updated to release 2.4 of Eshell.
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
79 @end ifnottex
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
80
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
81 @menu
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
82 * What is Eshell?:: A brief introduction to the Emacs Shell.
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
83 * Installation:: For users of Emacs 20 and XEmacs.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
84 * Command basics:: The basics of command usage.
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
85 * Commands::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
86 * Arguments::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
87 * Input/Output::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
88 * Process control::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
89 * Extension modules::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
90 * Extras and Goodies::
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
91 * Bugs and ideas:: Known problems, and future ideas.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
92 * Concept Index::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
93 * Function and Variable Index::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
94 * Key Index::
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
95 @end menu
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
96
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
97 @node What is Eshell?
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
98 @chapter What is Eshell?
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
99 @cindex what is Eshell?
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
100 @cindex Eshell, what it is
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
101
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
102 Eshell is a @dfn{command shell} written in Emacs Lisp. Everything it
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
103 does, it uses Emacs' facilities to do. This means that Eshell is as
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
104 portable as Emacs itself. It also means that cooperation with Lisp code
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
105 is natural and seamless.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
106
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
107 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
108 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
109 computer is a tool; in order to use that tool, you must tell it what to
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
110 do---or give it ``commands.'' These commands take many forms, such as
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
111 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
112 one form of command input.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
113
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
114 By far the most versatile way to express what you want the computer to
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
115 do is by using an abbreviated language called @dfn{script}. In
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
116 script, instead of telling the computer, ``list my files, please'',
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
117 one writes a standard abbreviated command word---@samp{ls}. Typing
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
118 @samp{ls} in a command shell is a script way of telling the computer
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
119 to list your files.@footnote{This is comparable to viewing the
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
120 contents of a folder using a graphical display.}
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
121
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
122 The real flexibility of this approach is apparent only when you realize
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
123 that there are many, many different ways to list files. Perhaps you
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
124 want them sorted by name, sorted by date, in reverse order, or grouped
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
125 by type. Most graphical browsers have simple ways to express this. But
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
126 what about showing only a few files, or only files that meet a certain
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
127 criteria? In very complex and specific situations, the request becomes
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
128 too difficult to express using a mouse or pointing device. It is just
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
129 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
130
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
131 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
132 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
133 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
134 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
135 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
136 without using a command shell.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
137
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
138 The role of a command shell is to give you more control over what your
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
139 computer does for you. Not everyone needs this amount of control, and
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
140 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
141 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
142 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
143 computer frequently enough, it is more than worthwhile in the long run.
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
144 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
145 @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
146 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
147 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
148
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
149 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
150
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
151 @menu
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
152 * 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
153 @end menu
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
154
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
155 @node Contributors to Eshell
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
156 @section Contributors to Eshell
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
157 @cindex contributors
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
158 @cindex authors
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
159
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
160 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
161 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
162 this package.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
163
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
164 The following persons have made contributions to Eshell.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
165
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
166 @itemize @bullet
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
167 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
168 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
169 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
170 does not have such support.@refill
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
171
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
172 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
173 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
174
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
175 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
176 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
177 things better for all.@refill
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
178
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
179 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
180 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
181 integration with Emacs 21.@refill
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
182
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
183 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
184 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
185 before overwriting files.@refill
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
186
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
187 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
188 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
189 @end itemize
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
190
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
191 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
192 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
193 there would be no new releases of Eshell.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
194
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
195 @node Installation
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
196 @chapter Installation
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
197 @cindex installation
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
198
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
199 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
200 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
201 recent version of Eshell from
48786
90cdeb7dd535 Fix URL.
Pavel Janík <Pavel@Janik.cz>
parents: 47737
diff changeset
202 @url{http://www.gci-net.com/users/j/johnw/Emacs/packages/eshell.tar.gz}.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
203
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
204 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
205
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
206 @section Short Form
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
207
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
208 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
209
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
210 @enumerate
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
211 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
212 @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
213
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
214 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
215 @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
216
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
217 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
218 @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
219
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
220 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
221 @samp{M-x eshell RET}.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
222
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
223 You should see a version banner displayed.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
224
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
225 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
226 @samp{ls RET}.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
227
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
228 Confirm that you see a file listing.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
229
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
230 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
231 @samp{eshell-test RET}.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
232
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
233 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
234 not.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
235
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
236 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
237 @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
238
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
239 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
240 @samp{find-file Makefile RET}.
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
241
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
242 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
243 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
244
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
245 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
246 @samp{M-x eshell RET}.
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
247
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
248 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
249 @samp{make install RET}.
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
250
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
251 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
252 @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
253
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
254 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
255 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
256
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
257 @example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
258 (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
259 (load "eshell-auto")
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
260 @end example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
261
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
262 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
263 @samp{M-x eshell RET}.
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
264
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
265 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
266 @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
267
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
268 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
269 Select the extension modules you prefer.
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
270
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
271 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
272 Restart Emacs!
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
273
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
274 @item
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
275 @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
276
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
277 Read the manual and enjoy!
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
278 @end enumerate
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
279
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
280 @section Long Form
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
281
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
282 @enumerate
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
283 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
284 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
285 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
286 @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
287 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
288 then selecting the file @file{eshell-auto.el}.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
289
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
290 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
291 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
292 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
293 typing:
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
294
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
295 @example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
296 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
297 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
298 @end example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
299
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
300 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
301 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
302 typing @kbd{M-x eshell}.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
303
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
304 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
305 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
306 @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
307 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
308
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
309 @item
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
310 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
311 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
312 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
313 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
314 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
315 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
316 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
317
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
318 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
319 Edit the file @file{Makefile} in the directory containing the Eshell
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
320 sources to reflect the location of certain Emacs directories at your
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
321 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
322 @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
323 @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
324
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
325 @item
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
326 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
327 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
328 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
329 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
330 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
331 be found on your system.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
332
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
333 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
334 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
335
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
336 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
337 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
338 @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
339 line to your @file{.emacs} file:
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
340
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
341 @example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
342 (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
343 @end example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
344
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
345 The actual directory on your system may differ.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
346
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
347 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
348 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
349 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
350 @file{site-lisp} directory (usually
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
351 @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
352 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
353
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
354 @example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
355 (load "eshell-auto")
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
356 @end example
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
357
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
358 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
359 Restart Emacs. After restarting, customize the variable
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
360 @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
361 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
362 of those modules in the Info manual.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
363 @end enumerate
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
364
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
365 @cindex documentation, printed version
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
366 @cindex printed version of documentation
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
367 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
368 from @file{eshell.texi}.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
369
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
370 @enumerate
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
371 @item
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
372 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
373 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
374 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
375
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
376 @item
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
377 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
378 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
379 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
380 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
381 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
382 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
383 @end enumerate
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
384
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
385 @node Command basics
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
386 @chapter Basic overview
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
387
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
388 A command shell is a means of entering verbally-formed commands. This
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
389 is really all that it does, and every feature described in this manual
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
390 is a means to that end. Therefore, it's important to take firm hold on
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
391 exactly what a command is, and how it fits in the overall picture of
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
392 things.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
393
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
394 @menu
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
395 * Commands verbs:: Commands always begin with a verb.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
396 * Command arguments:: Some verbs require arguments.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
397 @end menu
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
398
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
399 @node Commands verbs
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
400 @section Commands verbs
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
401
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
402 Commands are expressed using @dfn{script}, a special shorthand language
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
403 computers can understand with no trouble. Script is an extremely simple
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
404 language; oddly enough, this is what makes it look so complicated!
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
405 Whereas normal languages use a variety of embellishments, the form of a
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
406 script command is always:
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
407
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
408 @example
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
409 @var{verb} [@var{arguments}]
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
410 @end example
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
411
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
412 The verb expresses what you want your computer to do. There are a fixed
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
413 number of verbs, although this number is usually quite large. On the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
414 author's computer, it reaches almost 1400 in number. But of course,
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
415 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
416
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
417 Sometimes, the verb is all that's written. A verb is always a single
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
418 word, usually related to the task it performs. @command{reboot} is a
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
419 good example. Entering that on GNU/Linux will reboot the
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
420 computer---assuming you have sufficient privileges.
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
421
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
422 Other verbs require more information. These are usually very capable
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
423 verbs, and must be told specifically what to do. The extra information
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
424 is given in the form of @dfn{arguments}. For example, the
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
425 @command{echo} verb prints back whatever arguments you type. It
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
426 requires these arguments to know what to echo. A proper use of
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
427 @command{echo} looks like this:
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
428
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
429 @example
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
430 echo This is an example of using echo!
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
431 @end example
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
432
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
433 This script command causes the computer to echo back: ``This is an
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
434 example of using echo!''
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
435
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
436 Although command verbs are always simple words, like @command{reboot} or
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
437 @command{echo}, arguments may have a wide variety of forms. There are
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
438 textual arguments, numerical arguments---even Lisp arguments.
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
439 Distinguishing these different types of arguments requires special
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
440 typing, for the computer to know exactly what you mean.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
441
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
442 @node Command arguments
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
443 @section Command arguments
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
444
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
445 Eshell recognizes several different kinds of command arguments:
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
446
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
447 @enumerate
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
448 @item Strings (also called textual arguments)
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
449 @item Numbers (floating point or integer)
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
450 @item Lisp lists
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
451 @item Lisp symbols
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
452 @item Emacs buffers
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
453 @item Emacs process handles
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
454 @end enumerate
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
455
35667
84253e69015f Fix a couple of typos and fix markup of \.
Eli Zaretskii <eliz@gnu.org>
parents: 35588
diff changeset
456 Most users need to worry only about the first two. The third, Lisp lists,
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
457 occur very frequently, but almost always behind the scenes.
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
458
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
459 Strings are the most common type of argument, and consist of nearly any
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
460 character. Special characters---those used by Eshell
35667
84253e69015f Fix a couple of typos and fix markup of \.
Eli Zaretskii <eliz@gnu.org>
parents: 35588
diff changeset
461 specifically---must be preceded by a backslash (@samp{\}). When in doubt, it
84253e69015f Fix a couple of typos and fix markup of \.
Eli Zaretskii <eliz@gnu.org>
parents: 35588
diff changeset
462 is safe to add backslashes anywhere and everywhere.
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
463
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
464 Here is a more complicated @command{echo} example:
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
465
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
466 @example
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
467 echo A\ Multi-word\ Argument\ With\ A\ \$\ dollar
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
468 @end example
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
469
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
470 Beyond this, things get a bit more complicated. While not beyond the
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
471 reach of someone wishing to learn, it is definitely beyond the scope of
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
472 this manual to present it all in a simplistic manner. Get comfortable
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
473 with Eshell as a basic command invocation tool, and learn more about the
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
474 commands on your system; then come back when it all sits more familiarly
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
475 on your mind. Have fun!
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
476
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
477 @node Commands
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
478 @chapter Commands
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
479
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
480 @menu
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
481 * Invocation::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
482 * Completion::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
483 * Aliases::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
484 * History::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
485 * Scripts::
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
486 * Built-ins::
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
487 @end menu
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
488
37283
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
489 Essentially, a command shell is all about invoking commands---and
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
490 everything that entails. So understanding how Eshell invokes commands
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
491 is the key to comprehending how it all works.
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
492
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
493 @node Invocation
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
494 @section Invocation
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
495
37283
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
496 Unlike regular system shells, Eshell never invokes kernel functions
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
497 directly, such as @code{exec(3)}. Instead, it uses the Lisp functions
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
498 available in the Emacs Lisp library. It does this by transforming the
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
499 command you specify into a callable Lisp form.@footnote{To see the Lisp
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
500 form that will be invoked, type: @samp{eshell-parse-command "echo
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
501 hello"}}
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
502
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
503 This transformation, from the string of text typed at the command
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
504 prompt, to the ultimate invocation of either a Lisp function or external
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
505 command, follows these steps:
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
506
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
507 @enumerate
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
508 @item Parse the command string into separate arguments.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
509 @item
37283
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
510 @end enumerate
433e5fe5454d A few additions.
John Wiegley <johnw@newartisans.com>
parents: 36508
diff changeset
511
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
512 @node Completion
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
513 @section Completion
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
514
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
515 @node Aliases
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
516 @section Aliases
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
517
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
518 @node History
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
519 @section History
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
520
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
521 Eshell knows a few built-in variables:
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
522
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
523 @table @code
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
524
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
525 @item $+
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
526 @vindex $+
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
527 This variable always contains the current working directory.
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
528
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
529 @item $-
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
530 @vindex $-
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
531 This variable always contains the previous working directory (the
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
532 current working directory from before the last @code{cd} command).
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
533
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
534 @end table
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
535
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
536 @node Scripts
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
537 @section Scripts
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
538
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
539
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
540 @node Built-ins
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
541 @section Built-in commands
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
542
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
543 Here is a list of built-in commands that Eshell knows about:
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
544
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
545 @table @code
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
546
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
547 @item cd
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
548 @findex cd
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
549 This command changes the current working directory. Usually, it is
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
550 invoked as @samp{cd foo} where @file{foo} is the new working
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
551 directory. But @code{cd} knows about a few special arguments:
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
552
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
553 When it receives no argument at all, it changes to the home directory.
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
554
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
555 Giving the command @samp{cd -} changes back to the previous working
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
556 directory (this is the same as @samp{cd $-}).
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
557
45867
98bbf6d8534b *** empty log message ***
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 45862
diff changeset
558 The command @samp{cd =} shows the directory stack. Each line is
98bbf6d8534b *** empty log message ***
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 45862
diff changeset
559 numbered.
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
560
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
561 With @samp{cd =foo}, Eshell searches the directory stack for a
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
562 directory matching the regular expression @samp{foo} and changes to
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
563 that directory.
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
564
45867
98bbf6d8534b *** empty log message ***
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 45862
diff changeset
565 With @samp{cd -42}, you can access the directory stack by number.
98bbf6d8534b *** empty log message ***
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 45862
diff changeset
566
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
567 @end table
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
568
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
569
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
570 @node Arguments
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
571 @chapter Arguments
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
572
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
573 @menu
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
574 * The Parser::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
575 * Variables::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
576 * Substitution::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
577 * Globbing::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
578 * Predicates::
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
579 @end menu
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
580
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
581 @node The Parser
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
582 @section The Parser
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
583
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
584 @node Variables
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
585 @section Variables
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
586
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
587 @node Substitution
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
588 @section Substitution
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
589
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
590 @node Globbing
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
591 @section Globbing
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
592
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
593 @node Predicates
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
594 @section Predicates
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
595
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
596
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
597 @node Input/Output
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
598 @chapter Input/Output
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
599
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
600 @node Process control
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
601 @chapter Process control
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
602
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
603
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
604 @node Extension modules
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
605 @chapter Extension modules
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
606
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
607 @menu
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
608 * Writing a module::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
609 * Module testing::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
610 * Directory handling::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
611 * Key rebinding::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
612 * Smart scrolling::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
613 * Terminal emulation::
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
614 * Built-in UNIX commands::
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
615 @end menu
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
616
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
617 @node Writing a module
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
618 @section Writing a module
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
619
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
620 @node Module testing
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
621 @section Module testing
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
622
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
623 @node Directory handling
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
624 @section Directory handling
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
625
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
626 @node Key rebinding
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
627 @section Key rebinding
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
628
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
629 @node Smart scrolling
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
630 @section Smart scrolling
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
631
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
632 @node Terminal emulation
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
633 @section Terminal emulation
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
634
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
635 @node Built-in UNIX commands
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
636 @section Built-in UNIX commands
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
637
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
638
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
639 @node Extras and Goodies
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
640 @chapter Extras and Goodies
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
641
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
642 @node Bugs and ideas
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
643 @chapter Bugs and ideas
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
644 @cindex reporting bugs and ideas
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
645 @cindex bugs, how to report them
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
646 @cindex author, how to reach
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
647 @cindex email to the author
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
648 @cindex FAQ
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
649 @cindex problems, list of common
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
650
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
651 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
652 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
653 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
654 unrelated bugs, please report them separately.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
655
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
656 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
657 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
658 find this package useful!
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
659
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
660 @menu
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
661 * Known problems::
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
662 @end menu
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
663
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
664 @node Known problems
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
665 @section Known problems
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
666 @cindex known bugs
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
667 @cindex bugs, known
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
668
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
669 Below is complete list of known problems with Eshell version 2.4.1,
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
670 which is the version included with Emacs 21.1.
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
671
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
672 @table @asis
53171
768493812366 (Known Problems): Add doc item.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
673 @item Documentation incomplete
768493812366 (Known Problems): Add doc item.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
674
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
675 @item Differentiate between aliases and functions
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
676
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
677 Allow for a bash-compatible syntax, such as:
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
678
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
679 @example
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
680 alias arg=blah
33022
4c98dfd09341 Corrected some typos
John Wiegley <johnw@newartisans.com>
parents: 33020
diff changeset
681 function arg () @{ blah $* @}
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
682 @end example
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
683
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
684 @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
685
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
686 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
687 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
688 @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
689 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
690 structured command thing is too complicated at present.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
691
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
692 @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
693
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
694 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
695 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
696
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
697 @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
698
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
699 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
700 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
701
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
702 @item Pcomplete sometimes gets stuck
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
703
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
704 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
705 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
706
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
707 @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
708
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
709 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
710 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
711 temporary file, which has since been deleted.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
712
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
713 @item Problem with C-r repeating text
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
714
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
715 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
716 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
717
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
718 @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
719
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
720 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
721 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
722 scrolls back.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
723
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
724 @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
725
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
726 @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
727
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
728 @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
729
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 45867
diff changeset
730 This happened a few times in Emacs 21, but has been unreproducible
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
731 since.
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
732
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
733 @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
734
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
735 @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
736
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
737 @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
738
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
739 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
740 called with the input strings as arguments. This will require changing
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
741 @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
742
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
743 @item Input redirection is not supported
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
744
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
745 See the above entry.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
746
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
747 @item Problem running @command{less} without arguments on Windows
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
748
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
749 The result in the Eshell buffer is:
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
750
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
751 @example
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
752 Spawning child process: invalid argument
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
753 @end example
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
754
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
755 Also a new @command{less} buffer was created with nothing in it@dots{}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
756 (presumably this holds the output of @command{less}).
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
757
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
758 If @command{less.exe} is invoked from the Eshell command line, the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
759 expected output is written to the buffer.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
760
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
761 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
762 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
763 for running shells.
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
764
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
765 @item Implement @samp{-r}, @samp{-n} and @samp{-s} switches for @command{cp}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
766
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
767 @item Make @kbd{M-5 M-x eshell} switch to ``*eshell<5>*'', creating if need be
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
768
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
769 @item @samp{mv @var{dir} @var{file}.tar} does not remove directories
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
770
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
771 This is because the tar option --remove-files doesn't do so. Should it
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
772 be Eshell's job?
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
773
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
774 @item Bind @code{standard-output} and @code{standard-error}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
775
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
776 This would be so that if a Lisp function calls @code{print}, everything
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
777 will happen as it should (albeit slowly).
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
778
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
779 @item When an extension module fails to load, @samp{cd /} gives a Lisp error
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
780
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
781 @item If a globbing pattern returns one match, should it be a list?
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
782
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
783 @item Make sure syntax table is correct in Eshell mode
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
784
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
785 So that @kbd{M-DEL} acts in a predictable manner, etc.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
786
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
787 @item Allow all Eshell buffers to share the same history and list-dir
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
788
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
789 @item There is a problem with script commands that output to @file{/dev/null}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
790
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
791 If a script file, somewhere in the middle, uses @samp{> /dev/null},
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
792 output from all subsequent commands is swallowed.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
793
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
794 @item Split up parsing of text after @samp{$} in @file{esh-var.el}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
795
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
796 Make it similar to the way that @file{esh-arg.el} is structured.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
797 Then add parsing of @samp{$[?\n]}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
798
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
799 @item After pressing @kbd{M-RET}, redisplay before running the next command
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
800
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
801 @item Argument predicates and modifiers should work anywhere in a path
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
802
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
803 @example
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
804 /usr/local/src/editors/vim $ vi **/CVS(/)/Root(.)
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
805 Invalid regexp: "Unmatched ( or \\("
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
806 @end example
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
807
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
808 With @command{zsh}, the glob above expands to all files named
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
809 @file{Root} in directories named @file{CVS}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
810
33022
4c98dfd09341 Corrected some typos
John Wiegley <johnw@newartisans.com>
parents: 33020
diff changeset
811 @item Typing @samp{echo $@{locate locate@}/bin<TAB>} results in a Lisp error
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
812
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
813 Perhaps it should interpolate all permutations, and make that the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
814 globbing result, since otherwise hitting return here will result in
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
815 ``(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
816 @command{cat} only C backup files by using @samp{ls $@{identity *.c@}~}.
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
817 In that case, having an alias command name @command{glob} for
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
818 @command{identity} would be useful.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
819
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
820 @item Once symbolic mode is supported for @command{umask}, implement @command{chmod} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
821
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
822 @item Create @code{eshell-expand-file-name}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
823
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
824 This would use a data table to transform things such as @samp{~+},
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
825 @samp{...}, etc.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
826
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
827 @item Abstract @file{em-smart.el} into @file{smart-scroll.el}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
828
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
829 It only really needs: to be hooked onto the output filter and the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
830 pre-command hook, and to have the input-end and input-start markers.
36508
753bb928f910 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 35667
diff changeset
831 And to know whether the last output group was ``successful.''
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
832
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
833 @item Allow for fully persisting the state of Eshell
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
834
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
835 This would include: variables, history, buffer, input, dir stack, etc.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
836
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
837 @item Implement D as an argument predicate
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
838
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
839 It means that files beginning with a dot should be included in the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
840 glob match.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
841
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
842 @item A comma in a predicate list should mean OR
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
843
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
844 At the moment, this is not supported.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
845
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
846 @item Error if a glob doesn't expand due to a predicate
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
847
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
848 An error should be generated only if @code{eshell-error-if-no-glob} is
56279
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 54836
diff changeset
849 non-@code{nil}.
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
850
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
851 @item @samp{(+ RET SPC TAB} does not cause @code{indent-according-to-mode} to occur
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
852
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
853 @item Create @code{eshell-auto-accumulate-list}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
854
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
855 This is a list of commands for which, if the user presses @kbd{RET}, the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
856 text is staged as the next Eshell command, rather than being sent to the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
857 current interactive process.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
858
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
859 @item Display file and line number if an error occurs in a script
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
860
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
861 @item @command{wait} doesn't work with process ids at the moment
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
862
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
863 @item Enable the direct-to-process input code in @file{em-term.el}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
864
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
865 @item Problem with repeating @samp{echo $@{find /tmp@}}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
866
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
867 With smart display active, if @kbd{RET} is held down, after a while it
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
868 can't keep up anymore and starts outputting blank lines. It only
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
869 happens if an asynchronous process is involved@dots{}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
870
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
871 I think the problem is that @code{eshell-send-input} is resetting the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
872 input target location, so that if the asynchronous process is not done
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
873 by the time the next @kbd{RET} is received, the input processor thinks
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
874 that the input is meant for the process; which, when smart display is
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
875 enabled, will be the text of the last command line! That is a bug in
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
876 itself.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
877
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
878 In holding down @kbd{RET} while an asynchronous process is running,
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
879 there will be a point in between termination of the process, and the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
880 running of @code{eshell-post-command-hook}, which would cause
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
881 @code{eshell-send-input} to call @code{eshell-copy-old-input}, and then
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
882 process that text as a command to be run after the process. Perhaps
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
883 there should be a way of killing pending input between the death of the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
884 process, and the @code{post-command-hook}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
885
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
886 @item Allow for a more aggressive smart display mode
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
887
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
888 Perhaps toggled by a command, that makes each output block a smart
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
889 display block.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
890
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
891 @item Create more meta variables
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
892
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
893 @table @samp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
894 @item $!
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
895 The reason for the failure of the last disk command, or the text of the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
896 last Lisp error.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
897
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
898 @item $=
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
899 A special associate array, which can take references of the form
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
900 @samp{$=[REGEXP]}. It indexes into the directory ring.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
901 @end table
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
902
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
903 @item Eshell scripts can't execute in the background
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
904
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
905 @item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}}
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
906
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
907 @item Write an @command{info} alias that can take arguments
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
908
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
909 So that the user can enter @samp{info chmod}, for example.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
910
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
911 @item Create a mode @code{eshell-browse}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
912
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
913 It would treat the Eshell buffer as a outline. Collapsing the outline
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
914 hides all of the output text. Collapsing again would show only the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
915 first command run in each directory
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
916
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
917 @item Allow other revisions of a file to be referenced using @samp{file@{rev@}}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
918
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
919 This would be expanded by @code{eshell-expand-file-name} (see above).
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
920
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
921 @item Print ``You have new mail'' when the ``Mail'' icon is turned on
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
922
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
923 @item Implement @kbd{M-|} for Eshell
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
924
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
925 @item Implement input redirection
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
926
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
927 If it's a Lisp function, input redirection implies @command{xargs} (in a
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
928 way@dots{}). If input redirection is added, also update the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
929 @code{file-name-quote-list}, and the delimiter list.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
930
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
931 @item Allow @samp{#<@var{word} @var{arg}>} as a generic syntax
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
932
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
933 With the handling of @emph{word} specified by an
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
934 @code{eshell-special-alist}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
935
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
936 @item In @code{eshell-veal-using-options}, allow a @code{:complete} tag
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
937
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
938 It would be used to provide completion rules for that command. Then the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
939 macro will automagically define the completion function.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
940
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
941 @item For @code{eshell-command-on-region}, apply redirections to the result
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
942
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
943 So that @samp{+ > 'blah} would cause the result of the @code{+} (using
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
944 input from the current region) to be inserting into the symbol
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
945 @code{blah}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
946
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
947 If an external command is being invoked, the input is sent as standard
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
948 input, as if a @samp{cat <region> |} had been invoked.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
949
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
950 If a Lisp command, or an alias, is invoked, then if the line has no
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
951 newline characters, it is divided by whitespace and passed as arguments
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
952 to the Lisp function. Otherwise, it is divided at the newline
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
953 characters. Thus, invoking @code{+} on a series of numbers will add
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
954 them; @code{min} would display the smallest figure, etc.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
955
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
956 @item Write @code{eshell-script-mode} as a minor mode
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
957
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
958 It would provide syntax, abbrev, highlighting and indenting support like
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
959 @code{emacs-lisp-mode} and @code{shell-mode}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
960
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
961 @item In the history mechanism, finish the @command{bash}-style support
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
962
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
963 This means @samp{!n}, @samp{!#}, @samp{!:%}, and @samp{!:1-} as separate
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
964 from @samp{!:1*}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
965
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
966 @item Support the -n command line option for @command{history}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
967
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
968 @item Implement @command{fc} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
969
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
970 @item Specifying a frame as a redirection target should imply the currently active window's buffer
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
971
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
972 @item Implement @samp{>@var{func-or-func-list}}
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
973
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
974 This would allow for an ``output translators'', that take a function to
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
975 modify output with, and a target. Devise a syntax that works well with
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 45867
diff changeset
976 pipes, and can accommodate multiple functions (i.e., @samp{>'(upcase
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
977 regexp-quote)} or @samp{>'upcase}).
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
978
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
979 @item Allow Eshell to read/write to/from standard input and output
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
980
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
981 This would be optional, rather than always using the Eshell buffer.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
982 This would allow it to be run from the command line (perhaps).
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
983
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
984 @item Write a @command{help} command
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
985
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
986 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
987 @option{/?}, as appropriate.
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
988
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
989 @item Implement @command{stty} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
990
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
991 @item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}}
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
992
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
993 @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
994
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
995 Using @command{bg} on a process that is already in the background does
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
996 nothing. Specifying redirection targets replaces (or adds) to the list
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
997 current being used.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
998
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
999 @item Have @command{jobs} print only the processes for the current shell
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1000
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1001 @item How can Eshell learn if a background process has requested input?
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1002
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1003 @item Support @samp{2>&1} and @samp{>&} and @samp{2>} and @samp{|&}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1004
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1005 The syntax table for parsing these should be customizable, such that the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1006 user could change it to use rc syntax: @samp{>[2=1]}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1007
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1008 @item Allow @samp{$_[-1]}, which would indicate the last element of the array
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1009
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1010 @item Make @samp{$x[*]} equal to listing out the full contents of @samp{x}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1011
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1012 Return them as a list, so that @samp{$_[*]} is all the arguments of the
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1013 last command.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1014
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1015 @item Copy ANSI code handling from @file{term.el} into @file{em-term.el}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1016
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1017 Make it possible for the user to send char-by-char to the underlying
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1018 process. Ultimately, I should be able to move away from using term.el
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1019 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
1020 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
1021 (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
1022 it).
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1023
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1024 @item Make the shell spawning commands be visual
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1025
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1026 That is, make (@command{su}, @command{bash}, @command{telnet},
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1027 @command{rlogin}, @command{rsh}, etc.) be part of
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1028 @code{eshell-visual-commands}. The only exception is if the shell is
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1029 being used to invoke a single command. Then, the behavior should be
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1030 based on what that command is.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1031
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
1032 @item Create a smart viewing command named @command{open}
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1033
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1034 This would search for some way to open its argument (similar to opening
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1035 a file in the Windows Explorer).
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1036
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1037 @item Alias @command{read} to be the same as @command{open}, only read-only
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1038
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1039 @item Write a @command{tail} command which uses @code{view-file}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1040
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1041 It would move point to the end of the buffer, and then turns on
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1042 auto-revert mode in that buffer at frequent intervals---and a
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1043 @command{head} alias which assums an upper limit of
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1044 @code{eshell-maximum-line-length} characters per line.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1045
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1046 @item Make @command{dgrep} load @code{dired}, mark everything, then invoke @code{dired-do-search}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1047
35588
31904bdf4350 See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 34304
diff changeset
1048 @item Write mesh.c
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1049
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1050 This would run Emacs with the appropriate arguments to invoke Eshell
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1051 only. That way, it could be listed as a login shell.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1052
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1053 @item Use an intangible @code{PS2} string for multi-line input prompts
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1054
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1055 @item Auto-detect when a command is visual, by checking @code{TERMCAP} usage
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1056
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1057 @item The first keypress after @kbd{M-x watson} triggers `eshell-send-input'
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1058
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1059 @item Make @kbd{/} electric
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1060
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1061 So that it automatically expands and corrects pathnames. Or make
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1062 pathname completion for Pcomplete auto-expand @samp{/u/i/std<TAB>} to
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1063 @samp{/usr/include/std<TAB>}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1064
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1065 @item Write the @command{pushd} stack to disk along with @code{last-dir-ring}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1066
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1067 @item Add options to @code{eshell/cat} which would allow it to sort and uniq
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1068
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1069 @item Implement @command{wc} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1070
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1071 Add support for counting sentences, paragraphs, pages, etc.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1072
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1073 @item Once piping is added, implement @command{sort} and @command{uniq} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1074
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1075 @item Implement @command{touch} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1076
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1077 @item Implement @command{comm} in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1078
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1079 @item Implement an @command{epatch} command in Lisp
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1080
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1081 This would call @code{ediff-patch-file}, or @code{ediff-patch-buffer},
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1082 depending on its argument.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1083
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1084 @item Have an option such that @samp{ls -l} generates a dired buffer
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1085
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1086 @item Write a version of @command{xargs} based on command rewriting
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1087
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1088 That is, @samp{find X | xargs Y} would be indicated using @samp{Y
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1089 $@{find X@}}. Maybe @code{eshell-do-pipelines} could be changed to
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1090 perform this on-thy-fly rewriting.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1091
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1092 @item Write an alias for @command{less} that brings up a @code{view-mode} buffer
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1093
33030
867e27924dcd Some markup fixes. Don't call Windows a ``win''.
Eli Zaretskii <eliz@gnu.org>
parents: 33022
diff changeset
1094 Such that the user can press @key{SPC} and @key{DEL}, and then @key{q}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48786
diff changeset
1095 to return to Eshell. It would be equivalent to:
33020
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1096 @samp{X > #<buffer Y>; view-buffer #<buffer Y>}.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1097
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1098 @item Make @code{eshell-mode} as much a full citizen as @code{shell-mode}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1099
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1100 Everywhere in Emacs where @code{shell-mode} is specially noticed, add
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1101 @code{eshell-mode} there.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1102
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1103 @item Permit the umask to be selectively set on a @command{cp} target
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1104
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1105 @item Problem using @kbd{M-x eshell} after using @code{eshell-command}
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1106
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1107 If the first thing that I do after entering Emacs is to run
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1108 @code{eshell-command} and invoke @command{ls}, and then use @kbd{M-x
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1109 eshell}, it doesn't display anything.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1110
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1111 @item @kbd{M-RET} during a long command (using smart display) doesn't work
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1112
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1113 Since it keeps the cursor up where the command was invoked.
e21feeab77fb See ChangeLog
John Wiegley <johnw@newartisans.com>
parents: 32542
diff changeset
1114
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1115 @end table
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1116
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
1117 @node Concept Index
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1118 @unnumbered Concept Index
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1119
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1120 @printindex cp
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1121
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
1122 @node Function and Variable Index
32542
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
1123 @unnumbered Function and Variable Index
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
1124
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
1125 @printindex fn
9b4c05d377c9 Fix markup and chapter structure of the document.
Eli Zaretskii <eliz@gnu.org>
parents: 32451
diff changeset
1126
45862
1bcf7f390ca2 Remove unnecessary prev/next/up pointers in @node
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 37404
diff changeset
1127 @node Key Index
32450
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1128 @unnumbered Key Index
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1129
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1130 @printindex ky
99899af1ec94 Added the beginnings of proper Eshell documentation.
John Wiegley <johnw@newartisans.com>
parents:
diff changeset
1131 @bye
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
1132
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
1133 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
1134 arch-tag: 776409ba-cb15-42b9-b2b6-d2bdc7ebad01
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
1135 @end ignore