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