*** empty log message ***
[emacs.git] / man / eshell.texi
blob38c631313755d82272410dede6d0bd477d1cf93e
1 \input texinfo  @c -*-texinfo-*-
3 @c "@(#)$Name:  $:$Id: eshell.texi,v 1.11 2001/04/19 15:07:55 gerd 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, 2001  Free Software Foundation, Inc.
38 Permission is granted to copy, distribute and/or modify this document
39 under the terms of the GNU Free Documentation License, Version 1.1 or
40 any later version published by the Free Software Foundation; with no
41 Invariant Sections, with the Front-Cover texts being ``A GNU
42 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
43 license is included in the section entitled ``GNU Free Documentation
44 License'' in the Emacs manual.
46 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
47 this GNU Manual, like GNU software.  Copies published by the Free
48 Software Foundation raise funds for GNU development.''
50 This document is part of a collection distributed under the GNU Free
51 Documentation License.  If you want to distribute this document
52 separately from the collection, you can do so by adding a copy of the
53 license to the document, as described in section 6 of the license.
54 @end ifinfo
56 @synindex vr fn
57 @c The titlepage section does not appear in the Info file.
58 @titlepage
59 @sp 4
60 @c The title is printed in a large font.
61 @center @titlefont{User's Guide}
62 @sp
63 @center @titlefont{to}
64 @sp
65 @center @titlefont{Eshell: The Emacs Shell}
66 @ignore
67 @sp 2
68 @center release 2.4
69 @c -release-
70 @end ignore
71 @sp 3
72 @center John Wiegley
73 @c -date-
75 @c  The following two commands start the copyright page for the printed
76 @c  manual.  This will not appear in the Info file.
77 @page
78 @vskip 0pt plus 1filll
79 Copyright @copyright{} 1999, 2000, 2001  Free Software Foundation, Inc.
81 Permission is granted to copy, distribute and/or modify this document
82 under the terms of the GNU Free Documentation License, Version 1.1 or
83 any later version published by the Free Software Foundation; with no
84 Invariant Sections, with the Front-Cover texts being ``A GNU
85 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
86 license is included in the section entitled ``GNU Free Documentation
87 License'' in the Emacs manual.
89 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
90 this GNU Manual, like GNU software.  Copies published by the Free
91 Software Foundation raise funds for GNU development.''
93 This document is part of a collection distributed under the GNU Free
94 Documentation License.  If you want to distribute this document
95 separately from the collection, you can do so by adding a copy of the
96 license to the document, as described in section 6 of the license.
97 @end titlepage
99 @contents
101 @c ================================================================
102 @c                   The real text starts here
103 @c ================================================================
105 @node Top, What is Eshell?, (dir), (dir)
106 @ifinfo
107 @top Eshell
109 This manual documents Eshell, a shell-like command interpretor
110 implemented in Emacs Lisp.  It invokes no external processes except for
111 those requested by the user.  It is intended to be a functional
112 replacement for command shells such as @command{bash}, @command{zsh},
113 @command{rc}, or @command{4dos}; since Emacs itself is capable of
114 handling the sort of tasks accomplished by those tools.
115 @c This manual is updated to release 2.4 of Eshell.
116 @end ifinfo
118 @menu
119 * What is Eshell?::             A brief introduction to the Emacs Shell.
120 * Installation::                For users of Emacs 20 and XEmacs.
121 * Command basics::              The basics of command usage.     
122 * Commands::                    
123 * Arguments::                   
124 * Input/Output::                
125 * Process control::             
126 * Extension modules::           
127 * Extras and Goodies::          
128 * Bugs and ideas::              Known problems, and future ideas.
129 * Concept Index::               
130 * Function and Variable Index::  
131 * Key Index::                   
132 @end menu
134 @node What is Eshell?, Installation, Top, Top
135 @chapter What is Eshell?
136 @cindex what is Eshell?
137 @cindex Eshell, what it is
139 Eshell is a @dfn{command shell} written in Emacs Lisp.  Everything it
140 does, it uses Emacs' facilities to do.  This means that Eshell is as
141 portable as Emacs itself.  It also means that cooperation with Lisp code
142 is natural and seamless.
144 What is a command shell?  To properly understand the role of a shell,
145 it's necessary to visualize what a computer does for you.  Basically, a
146 computer is a tool; in order to use that tool, you must tell it what to
147 do---or give it ``commands.''  These commands take many forms, such as
148 clicking with a mouse on certain parts of the screen.  But that is only
149 one form of command input.
151 By far the most versatile way to express what you want the computer to
152 do is by using an abbreviated language called @dfn{script}.  In
153 script, instead of telling the computer, ``list my files, please'',
154 one writes a standard abbreviated command word---@samp{ls}.  Typing
155 @samp{ls} in a command shell is a script way of telling the computer
156 to list your files.@footnote{This is comparable to viewing the
157 contents of a folder using a graphical display.}
159 The real flexibility of this approach is apparent only when you realize
160 that there are many, many different ways to list files.  Perhaps you
161 want them sorted by name, sorted by date, in reverse order, or grouped
162 by type.  Most graphical browsers have simple ways to express this.  But
163 what about showing only a few files, or only files that meet a certain
164 criteria?  In very complex and specific situations, the request becomes
165 too difficult to express using a mouse or pointing device.  It is just
166 these kinds of requests that are easily solved using a command shell.
168 For example, what if you want to list every Word file on your hard
169 drive, larger than 100 kilobytes in size, and which hasn't been looked
170 at in over six months?  That is a good candidate list for deletion, when
171 you go to clean up your hard drive.  But have you ever tried asking your
172 computer for such a list?  There is no way to do it!  At least, not
173 without using a command shell.
175 The role of a command shell is to give you more control over what your
176 computer does for you.  Not everyone needs this amount of control, and
177 it does come at a cost: Learning the necessary script commands to
178 express what you want done.  A complicated query, such as the example
179 above, takes time to learn.  But if you find yourself using your
180 computer frequently enough, it is more than worthwhile in the long run.
181 Any tool you use often deserves the time spent learning to master it.
182 @footnote{For the understandably curious, here is what that command
183 looks like: But don't let it fool you; once you know what's going on,
184 it's easier than it looks: @code{ls -lt **/*.doc(Lk+50aM+5)}.}
186 As of Emacs 21, Eshell is part of the standard Emacs distribution.
188 @menu
189 * Contributors to Eshell::      People who have helped out!
190 @end menu
192 @node Contributors to Eshell,  , What is Eshell?, What is Eshell?
193 @section Contributors to Eshell
194 @cindex contributors
195 @cindex authors
197 Contributions to Eshell are welcome.  I have limited time to work on
198 this project, but I will gladly add any code you contribute to me to
199 this package.
201 The following persons have made contributions to Eshell.
203 @itemize @bullet
204 @item
205 Eli Zaretskii made it possible for Eshell to run without requiring
206 asynchronous subprocess support.  This is important for MS-DOS, which
207 does not have such support.@refill
209 @item
210 Miles Bader contributed many fixes during the port to Emacs 21.@refill
212 @item
213 Stefan Monnier fixed the things which bothered him, which of course made
214 things better for all.@refill
216 @item
217 Gerd Moellmann also helped to contribute bug fixes during the initial
218 integration with Emacs 21.@refill
220 @item
221 Alex Schroeder contributed code for interactively querying the user
222 before overwriting files.@refill
224 @item
225 Sudish Joseph helped with some XEmacs compatibility issues.@refill
226 @end itemize
228 Apart from these, a lot of people have sent suggestions, ideas,
229 requests, bug reports and encouragement.  Thanks a lot!  Without you
230 there would be no new releases of Eshell.
232 @node Installation, Command basics, What is Eshell?, Top
233 @chapter Installation
234 @cindex installation
236 As mentioned above, Eshell comes preinstalled as of Emacs 21.  If you're
237 using Emacs 20.4 or later, or XEmacs 21, you can download the most
238 recent version of Eshell from
239 @url{http://www.gci-net.com/users/j/johnw/Emacs/eshell.tar.gz}.
241 However, if you are using Emacs 21, you may skip this section.
243 @section Short Form
245 Here's exactly what to do, with no explanation why:
247 @enumerate
248 @item
249 @samp{M-x load-file RET eshell-auto.el RET}.
251 @item
252 @samp{ESC : (add-to-list 'load-path "<path where Eshell resides>") RET}.
254 @item
255 @samp{ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET}.
257 @item
258 @samp{M-x eshell RET}.
260 You should see a version banner displayed.
262 @item
263 @samp{ls RET}.
265 Confirm that you see a file listing.
267 @item
268 @samp{eshell-test RET}.
270 Confirm that everything runs correctly.  Use @kbd{M-x eshell-report-bug} if
271 not.
273 @item
274 @samp{cd $@{dirname (locate-library "eshell-auto")@} RET}.
276 @item
277 @samp{find-file Makefile RET}.
279 @item
280 Edit the Makefile to reflect your site.
282 @item
283 @samp{M-x eshell RET}.
285 @item
286 @samp{make install RET}.
288 @item
289 @samp{find-file $user-init-file RET}.
291 @item
292 Add the following lines to your @file{.emacs} file:
294 @example
295 (add-to-list 'load-path "<directory where you install Eshell>")
296 (load "eshell-auto")
297 @end example
299 @item
300 @samp{M-x eshell RET}.
302 @item
303 @samp{customize-option #'eshell-modules-list RET}.
305 @item
306 Select the extension modules you prefer.
308 @item
309 Restart Emacs!
311 @item
312 @samp{M-x info RET m Eshell RET}.
314 Read the manual and enjoy!
315 @end enumerate
317 @section Long Form
319 @enumerate
320 @item
321 Before building and installing Eshell, it is important to test that it
322 will work properly on your system.  To do this, first load the file
323 @file{eshell-auto}, which will define certain autoloads required to run
324 Eshell.  This can be done using the command @kbd{M-x load-file}, and
325 then selecting the file @file{eshell-auto.el}.
327 @item
328 In order for Emacs to find Eshell's files, the Eshell directory must be
329 added to the @code{load-path} variable.  This can be done within Emacs by
330 typing:
332 @example
333 ESC : (add-to-list 'load-path "<path where Eshell resides>") RET
334 ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET
335 @end example
337 @item
338 Start Eshell from the distributed sources, using default settings, by
339 typing @kbd{M-x eshell}.
341 @item
342 Verify that Eshell is functional by typing @command{ls} followed by
343 @key{RET}.  You should have already seen a version banner announcing the
344 version number of this release, followed by a prompt.
346 @item
347 Run the test suite by typing @command{eshell-test} followed by @key{RET}
348 in the Eshell buffer.  It is important that Emacs be left alone while
349 the tests are running, since extraneous command input may cause some of
350 the tests to fail (they were never intended to run in the background).
351 If all of the tests pass, Eshell should work just fine on your system.
352 If any of the tests fail, please send e-mail to the Eshell maintainer
353 using the command @kbd{M-x eshell-report-bug}.
355 @item
356 Edit the file @file{Makefile} in the directory containing the Eshell
357 sources to reflect the location of certain Emacs directories at your
358 site.  The only things you really have to change are the definitions of
359 @code{lispdir} and @code{infodir}.  The elisp files will be copied to
360 @code{lispdir}, and the info file to @code{infodir}.
362 @item
363 Type @kbd{make install} in the directory containing the Eshell sources.
364 This will byte-compile all of the @file{*.el} files and copy both the
365 source and compiled versions to the directories specified in the
366 previous step.  It will also copy the info file, and add a corresponding
367 entry to your @file{dir} file----if the program @code{install-info} can
368 be found on your system.
370 If you only want to create the compiled elisp files, but don't want to
371 install them, you can type just @kbd{make} instead.
373 @item
374 Add the directory into which Eshell was installed to your
375 @code{load-path} variable.  This can be done by adding the following
376 line to your @file{.emacs} file:
378 @example
379 (add-to-list 'load-path "/usr/local/share/emacs/site-lisp/eshell")
380 @end example
382 The actual directory on your system may differ.
384 @item
385 To install Eshell privately, edit your @file{.emacs} file; to install
386 Eshell site-wide, edit the file @file{site-start.el} in your
387 @file{site-lisp} directory (usually
388 @file{/usr/local/share/emacs/site-lisp} or something similar).  In
389 either case enter the following line into the appropriate file:
391 @example
392 (load "eshell-auto")
393 @end example
395 @item
396 Restart Emacs.  After restarting, customize the variable
397 @code{eshell-modules-list}.  This variable selects which Eshell
398 extension modules you want to use.  You will find documentation on each
399 of those modules in the Info manual.
400 @end enumerate
402 @cindex documentation, printed version
403 @cindex printed version of documentation
404 If you have @TeX{} installed at your site, you can make a typeset manual
405 from @file{eshell.texi}.
407 @enumerate
408 @item
409 Run @TeX{} by typing @kbd{texi2dvi eshell.texi}.  (With Emacs 21.1 or
410 later, typing @kbd{make eshell.dvi} in the @file{man/} subdirectory of
411 the Emacs source distribution will do that.)
413 @item
414 Convert the resulting device independent file @file{eshell.dvi} to a
415 form which your printer can output and print it.  If you have a
416 postscript printer, there is a program, @code{dvi2ps}, which does that; there
417 is also a program which comes together with @TeX{}, @code{dvips}, which
418 you can use.  For other printers, use a suitable DVI driver,
419 e.g., @code{dvilj4} for LaserJet-compatible printers.
420 @end enumerate
422 @node Command basics, Commands, Installation, Top
423 @chapter Basic overview
425 A command shell is a means of entering verbally-formed commands.  This
426 is really all that it does, and every feature described in this manual
427 is a means to that end.  Therefore, it's important to take firm hold on
428 exactly what a command is, and how it fits in the overall picture of
429 things.
431 @menu
432 * Commands verbs::              Commands always begin with a verb.
433 * Command arguments::           Some verbs require arguments.
434 @end menu
436 @node Commands verbs, Command arguments, Command basics, Command basics
437 @section Commands verbs
439 Commands are expressed using @dfn{script}, a special shorthand language
440 computers can understand with no trouble.  Script is an extremely simple
441 language; oddly enough, this is what makes it look so complicated!
442 Whereas normal languages use a variety of embellishments, the form of a
443 script command is always:
445 @example
446 @var{verb} [@var{arguments}]
447 @end example
449 The verb expresses what you want your computer to do.  There are a fixed
450 number of verbs, although this number is usually quite large.  On the
451 author's computer, it reaches almost 1400 in number.  But of course,
452 only a handful of these are really necessary.
454 Sometimes, the verb is all that's written.  A verb is always a single
455 word, usually related to the task it performs.  @command{reboot} is a
456 good example.  Entering that on GNU/Linux will reboot the
457 computer---assuming you have sufficient privileges.
459 Other verbs require more information.  These are usually very capable
460 verbs, and must be told specifically what to do.  The extra information
461 is given in the form of @dfn{arguments}.  For example, the
462 @command{echo} verb prints back whatever arguments you type.  It
463 requires these arguments to know what to echo.  A proper use of
464 @command{echo} looks like this:
466 @example
467 echo This is an example of using echo!
468 @end example
470 This script command causes the computer to echo back: ``This is an
471 example of using echo!''
473 Although command verbs are always simple words, like @command{reboot} or
474 @command{echo}, arguments may have a wide variety of forms.  There are
475 textual arguments, numerical arguments---even Lisp arguments.
476 Distinguishing these different types of arguments requires special
477 typing, for the computer to know exactly what you mean.
479 @node Command arguments,  , Commands verbs, Command basics
480 @section Command arguments
482 Eshell recognizes several different kinds of command arguments:
484 @enumerate
485 @item Strings (also called textual arguments)
486 @item Numbers (floating point or integer)
487 @item Lisp lists
488 @item Lisp symbols
489 @item Emacs buffers
490 @item Emacs process handles
491 @end enumerate
493 Most users need to worry only about the first two.  The third, Lisp lists,
494 occur very frequently, but almost always behind the scenes.
496 Strings are the most common type of argument, and consist of nearly any
497 character.  Special characters---those used by Eshell
498 specifically---must be preceded by a backslash (@samp{\}).  When in doubt, it
499 is safe to add backslashes anywhere and everywhere.
501 Here is a more complicated @command{echo} example:
503 @example
504 echo A\ Multi-word\ Argument\ With\ A\ \$\ dollar
505 @end example
507 Beyond this, things get a bit more complicated.  While not beyond the
508 reach of someone wishing to learn, it is definitely beyond the scope of
509 this manual to present it all in a simplistic manner.  Get comfortable
510 with Eshell as a basic command invocation tool, and learn more about the
511 commands on your system; then come back when it all sits more familiarly
512 on your mind.  Have fun!
514 @node Commands, Arguments, Command basics, Top
515 @chapter Commands
517 @menu
518 * Invocation::                  
519 * Completion::                  
520 * Aliases::                     
521 * History::                     
522 * Scripts::                     
523 @end menu
525 Essentially, a command shell is all about invoking commands---and
526 everything that entails.  So understanding how Eshell invokes commands
527 is the key to comprehending how it all works.
529 @node Invocation, Completion, Commands, Commands
530 @section Invocation
532 Unlike regular system shells, Eshell never invokes kernel functions
533 directly, such as @code{exec(3)}.  Instead, it uses the Lisp functions
534 available in the Emacs Lisp library.  It does this by transforming the
535 command you specify into a callable Lisp form.@footnote{To see the Lisp
536 form that will be invoked, type: @samp{eshell-parse-command "echo
537 hello"}}
539 This transformation, from the string of text typed at the command
540 prompt, to the ultimate invocation of either a Lisp function or external
541 command, follows these steps:
543 @enumerate
544 @item Parse the command string into separate arguments.
545 @item 
546 @end enumerate
548 @node Completion, Aliases, Invocation, Commands
549 @section Completion
551 @node Aliases, History, Completion, Commands
552 @section Aliases
554 @node History, Scripts, Aliases, Commands
555 @section History
557 @node Scripts,  , History, Commands
558 @section Scripts
561 @node Arguments, Input/Output, Commands, Top
562 @chapter Arguments
564 @menu
565 * The Parser::                  
566 * Variables::                   
567 * Substitution::                
568 * Globbing::                    
569 * Predicates::                  
570 @end menu
572 @node The Parser, Variables, Arguments, Arguments
573 @section The Parser
575 @node Variables, Substitution, The Parser, Arguments
576 @section Variables
578 @node Substitution, Globbing, Variables, Arguments
579 @section Substitution
581 @node Globbing, Predicates, Substitution, Arguments
582 @section Globbing
584 @node Predicates,  , Globbing, Arguments
585 @section Predicates
588 @node Input/Output, Process control, Arguments, Top
589 @chapter Input/Output
591 @node Process control, Extension modules, Input/Output, Top
592 @chapter Process control
595 @node Extension modules, Extras and Goodies, Process control, Top
596 @chapter Extension modules
598 @menu
599 * Writing a module::            
600 * Module testing::              
601 * Directory handling::          
602 * Key rebinding::               
603 * Smart scrolling::             
604 * Terminal emulation::          
605 * Built-in UNIX commands::      
606 @end menu
608 @node Writing a module, Module testing, Extension modules, Extension modules
609 @section Writing a module
611 @node Module testing, Directory handling, Writing a module, Extension modules
612 @section Module testing
614 @node Directory handling, Key rebinding, Module testing, Extension modules
615 @section Directory handling
617 @node Key rebinding, Smart scrolling, Directory handling, Extension modules
618 @section Key rebinding
620 @node Smart scrolling, Terminal emulation, Key rebinding, Extension modules
621 @section Smart scrolling
623 @node Terminal emulation, Built-in UNIX commands, Smart scrolling, Extension modules
624 @section Terminal emulation
626 @node Built-in UNIX commands,  , Terminal emulation, Extension modules
627 @section Built-in UNIX commands
630 @node Extras and Goodies, Bugs and ideas, Extension modules, Top
631 @chapter Extras and Goodies
633 @node Bugs and ideas, Concept Index, Extras and Goodies, Top
634 @chapter Bugs and ideas
635 @cindex reporting bugs and ideas
636 @cindex bugs, how to report them
637 @cindex author, how to reach
638 @cindex email to the author
639 @cindex FAQ
640 @cindex problems, list of common
642 If you find a bug or misfeature, don't hesitate to let me know!  Send
643 email to @email{johnw@@gnu.org}.  Feature requests should also be sent
644 there.  I prefer discussing one thing at a time.  If you find several
645 unrelated bugs, please report them separately.
647 If you have ideas for improvements, or if you have written some
648 extensions to this package, I would like to hear from you.  I hope you
649 find this package useful!
651 @menu
652 * Known problems::              
653 @end menu
655 @node Known problems,  , Bugs and ideas, Bugs and ideas
656 @section Known problems
657 @cindex known bugs
658 @cindex bugs, known
660 Below is complete list of known problems with Eshell version 2.4.1,
661 which is the version included with Emacs 21.1.
663 @table @asis
664 @item Differentiate between aliases and functions
666 Allow for a bash-compatible syntax, such as:
668 @example
669 alias arg=blah
670 function arg () @{ blah $* @}
671 @end example
673 @item @samp{for i in 1 2 3 @{ grep -q a b && *echo has it @} | wc -l} outputs result after prompt
675 In fact, piping to a process from a looping construct doesn't work in
676 general.  If I change the call to @code{eshell-copy-handles} in
677 @code{eshell-rewrite-for-command} to use @code{eshell-protect}, it seems
678 to work, but the output occurs after the prompt is displayed.  The whole
679 structured command thing is too complicated at present.
681 @item Error with @command{bc} in @code{eshell-test}
683 On some XEmacs system, the subprocess interaction test fails
684 inexplicably, although @command{bc} works fine at the command prompt.
686 @item Eshell does not delete @file{*Help*} buffers in XEmacs 21.1.8+
688 In XEmacs 21.1.8, the @file{*Help*} buffer has been renamed such that
689 multiple instances of the @file{*Help*} buffer can exist.
691 @item Pcomplete sometimes gets stuck
693 You press @key{TAB}, but no completions appear, even though the
694 directory has matching files.  This behavior is rare.
696 @item @samp{grep python $<rpm -qa>} doesn't work, but using @samp{*grep} does
698 This happens because the @code{grep} Lisp function returns immediately,
699 and then the asynchronous @command{grep} process expects to examine the
700 temporary file, which has since been deleted.
702 @item Problem with C-r repeating text
704 If the text @emph{before point} reads "./run", and you type @kbd{C-r r u
705 n}, it will repeat the line for every character typed.
707 @item Backspace doesn't scroll back after continuing (in smart mode)
709 Hitting space during a process invocation, such as @command{make}, will
710 cause it to track the bottom of the output; but backspace no longer
711 scrolls back.
713 @item It's not possible to fully @code{unload-feature} Eshell
715 @item Menu support was removed, but never put back
717 @item Using C-p and C-n with rebind gets into a locked state
719 This happened a few times in Emacs 21, but has been unreproducable
720 since.
722 @item If an interactive process is currently running, @kbd{M-!} doesn't work
724 @item Use a timer instead of @code{sleep-for} when killing child processes
726 @item Piping to a Lisp function is not supported
728 Make it so that the Lisp command on the right of the pipe is repeatedly
729 called with the input strings as arguments.  This will require changing
730 @code{eshell-do-pipeline} to handle non-process targets.
732 @item Input redirection is not supported
734 See the above entry.
736 @item Problem running @command{less} without arguments on Windows
738 The result in the Eshell buffer is:
740 @example
741 Spawning child process: invalid argument
742 @end example
744 Also a new @command{less} buffer was created with nothing in it@dots{}
745 (presumably this holds the output of @command{less}).
747 If @command{less.exe} is invoked from the Eshell command line, the
748 expected output is written to the buffer.
750 Note that this happens on NT-Emacs 20.6.1 on Windows 2000. The term.el
751 package and the supplied shell both use the @command{cmdproxy} program
752 for running shells.
754 @item Implement @samp{-r}, @samp{-n} and @samp{-s} switches for @command{cp}
756 @item Make @kbd{M-5 M-x eshell} switch to ``*eshell<5>*'', creating if need be
758 @item @samp{mv @var{dir} @var{file}.tar} does not remove directories
760 This is because the tar option --remove-files doesn't do so.  Should it
761 be Eshell's job?
763 @item Bind @code{standard-output} and @code{standard-error}
765 This would be so that if a Lisp function calls @code{print}, everything
766 will happen as it should (albeit slowly).
768 @item When an extension module fails to load, @samp{cd /} gives a Lisp error
770 @item If a globbing pattern returns one match, should it be a list?
772 @item Make sure syntax table is correct in Eshell mode
774 So that @kbd{M-DEL} acts in a predictable manner, etc.
776 @item Allow all Eshell buffers to share the same history and list-dir
778 @item There is a problem with script commands that output to @file{/dev/null}
780 If a script file, somewhere in the middle, uses @samp{> /dev/null},
781 output from all subsequent commands is swallowed.
783 @item Split up parsing of text after @samp{$} in @file{esh-var.el}
785 Make it similar to the way that @file{esh-arg.el} is structured.
786 Then add parsing of @samp{$[?\n]}.
788 @item After pressing @kbd{M-RET}, redisplay before running the next command
790 @item Argument predicates and modifiers should work anywhere in a path
792 @example
793 /usr/local/src/editors/vim $ vi **/CVS(/)/Root(.)
794 Invalid regexp: "Unmatched ( or \\("
795 @end example
797 With @command{zsh}, the glob above expands to all files named
798 @file{Root} in directories named @file{CVS}.
800 @item Typing @samp{echo $@{locate locate@}/bin<TAB>} results in a Lisp error
802 Perhaps it should interpolate all permutations, and make that the
803 globbing result, since otherwise hitting return here will result in
804 ``(list of filenames)/bin'', which is never valuable.  Thus, one could
805 @command{cat} only C backup files by using @samp{ls $@{identity *.c@}~}.
806 In that case, having an alias command name @command{glob} for
807 @command{identity} would be useful.
809 @item Once symbolic mode is supported for @command{umask}, implement @command{chmod} in Lisp
811 @item Create @code{eshell-expand-file-name}
813 This would use a data table to transform things such as @samp{~+},
814 @samp{...}, etc.
816 @item Abstract @file{em-smart.el} into @file{smart-scroll.el}
818 It only really needs: to be hooked onto the output filter and the
819 pre-command hook, and to have the input-end and input-start markers.
820 And to know whether the last output group was ``successful.''
822 @item Allow for fully persisting the state of Eshell
824 This would include: variables, history, buffer, input, dir stack, etc.
826 @item Implement D as an argument predicate
828 It means that files beginning with a dot should be included in the
829 glob match.
831 @item A comma in a predicate list should mean OR
833 At the moment, this is not supported.
835 @item Error if a glob doesn't expand due to a predicate
837 An error should be generated only if @code{eshell-error-if-no-glob} is
838 non-nil.
840 @item @samp{(+ RET SPC TAB} does not cause @code{indent-according-to-mode} to occur
842 @item Create @code{eshell-auto-accumulate-list}
844 This is a list of commands for which, if the user presses @kbd{RET}, the
845 text is staged as the next Eshell command, rather than being sent to the
846 current interactive process.
848 @item Display file and line number if an error occurs in a script
850 @item @command{wait} doesn't work with process ids at the moment
852 @item Enable the direct-to-process input code in @file{em-term.el}
854 @item Problem with repeating @samp{echo $@{find /tmp@}}
856 With smart display active, if @kbd{RET} is held down, after a while it
857 can't keep up anymore and starts outputting blank lines.  It only
858 happens if an asynchronous process is involved@dots{}
860 I think the problem is that @code{eshell-send-input} is resetting the
861 input target location, so that if the asynchronous process is not done
862 by the time the next @kbd{RET} is received, the input processor thinks
863 that the input is meant for the process; which, when smart display is
864 enabled, will be the text of the last command line!  That is a bug in
865 itself.
867 In holding down @kbd{RET} while an asynchronous process is running,
868 there will be a point in between termination of the process, and the
869 running of @code{eshell-post-command-hook}, which would cause
870 @code{eshell-send-input} to call @code{eshell-copy-old-input}, and then
871 process that text as a command to be run after the process.  Perhaps
872 there should be a way of killing pending input between the death of the
873 process, and the @code{post-command-hook}.
875 @item Allow for a more aggressive smart display mode
877 Perhaps toggled by a command, that makes each output block a smart
878 display block.
880 @item Create more meta variables
882 @table @samp
883 @item $!
884 The reason for the failure of the last disk command, or the text of the
885 last Lisp error.
887 @item $=
888 A special associate array, which can take references of the form
889 @samp{$=[REGEXP]}.  It indexes into the directory ring.
890 @end table
892 @item Eshell scripts can't execute in the background
894 @item Support zsh's ``Parameter Expansion'' syntax, i.e. @samp{$@{@var{name}:-@var{val}@}}
896 @item Write an @command{info} alias that can take arguments
898 So that the user can enter @samp{info chmod}, for example.
900 @item Create a mode @code{eshell-browse}
902 It would treat the Eshell buffer as a outline.  Collapsing the outline
903 hides all of the output text.  Collapsing again would show only the
904 first command run in each directory
906 @item Allow other revisions of a file to be referenced using @samp{file@{rev@}}
908 This would be expanded by @code{eshell-expand-file-name} (see above).
910 @item Print ``You have new mail'' when the ``Mail'' icon is turned on
912 @item Implement @kbd{M-|} for Eshell
914 @item Implement input redirection
916 If it's a Lisp function, input redirection implies @command{xargs} (in a
917 way@dots{}).  If input redirection is added, also update the
918 @code{file-name-quote-list}, and the delimiter list.
920 @item Allow @samp{#<@var{word} @var{arg}>} as a generic syntax
922 With the handling of @emph{word} specified by an
923 @code{eshell-special-alist}.
925 @item In @code{eshell-veal-using-options}, allow a @code{:complete} tag
927 It would be used to provide completion rules for that command.  Then the
928 macro will automagically define the completion function.
930 @item For @code{eshell-command-on-region}, apply redirections to the result
932 So that @samp{+ > 'blah} would cause the result of the @code{+} (using
933 input from the current region) to be inserting into the symbol
934 @code{blah}.
936 If an external command is being invoked, the input is sent as standard
937 input, as if a @samp{cat <region> |} had been invoked.
939 If a Lisp command, or an alias, is invoked, then if the line has no
940 newline characters, it is divided by whitespace and passed as arguments
941 to the Lisp function.  Otherwise, it is divided at the newline
942 characters.  Thus, invoking @code{+} on a series of numbers will add
943 them; @code{min} would display the smallest figure, etc.
945 @item Write @code{eshell-script-mode} as a minor mode
947 It would provide syntax, abbrev, highlighting and indenting support like
948 @code{emacs-lisp-mode} and @code{shell-mode}.
950 @item In the history mechanism, finish the @command{bash}-style support
952 This means @samp{!n}, @samp{!#}, @samp{!:%}, and @samp{!:1-} as separate
953 from @samp{!:1*}.
955 @item Support the -n command line option for @command{history}
957 @item Implement @command{fc} in Lisp
959 @item Specifying a frame as a redirection target should imply the currently active window's buffer
961 @item Implement @samp{>@var{func-or-func-list}}
963 This would allow for an ``output translators'', that take a function to
964 modify output with, and a target.  Devise a syntax that works well with
965 pipes, and can accomodate multiple functions (i.e., @samp{>'(upcase
966 regexp-quote)} or @samp{>'upcase}).
968 @item Allow Eshell to read/write to/from standard input and output
970 This would be optional, rather than always using the Eshell buffer.
971 This would allow it to be run from the command line (perhaps).
973 @item Write a @command{help} command
975 It would call subcommands with @option{--help}, or @option{-h} or
976 @option{/?}, as appropriate.
978 @item Implement @command{stty} in Lisp
980 @item Support @command{rc}'s matching operator, e.g. @samp{~ (@var{list}) @var{regexp}}
982 @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list}
984 Using @command{bg} on a process that is already in the background does
985 nothing.  Specifying redirection targets replaces (or adds) to the list
986 current being used.
988 @item Have @command{jobs} print only the processes for the current shell
990 @item How can Eshell learn if a background process has requested input?
992 @item Support @samp{2>&1} and @samp{>&} and @samp{2>} and @samp{|&}
994 The syntax table for parsing these should be customizable, such that the
995 user could change it to use rc syntax: @samp{>[2=1]}.
997 @item Allow @samp{$_[-1]}, which would indicate the last element of the array
999 @item Make @samp{$x[*]} equal to listing out the full contents of @samp{x}
1001 Return them as a list, so that @samp{$_[*]} is all the arguments of the
1002 last command.
1004 @item Copy ANSI code handling from @file{term.el} into @file{em-term.el}
1006 Make it possible for the user to send char-by-char to the underlying
1007 process.  Ultimately, I should be able to move away from using term.el
1008 altogether, since everything but the ANSI code handling is already part
1009 of Eshell.  Then, things would work correctly on MS-Windows as well
1010 (which doesn't have @file{/bin/sh}, although @file{term.el} tries to use
1011 it).
1013 @item Make the shell spawning commands be visual
1015 That is, make (@command{su}, @command{bash}, @command{telnet},
1016 @command{rlogin}, @command{rsh}, etc.) be part of
1017 @code{eshell-visual-commands}.  The only exception is if the shell is
1018 being used to invoke a single command.  Then, the behavior should be
1019 based on what that command is.
1021 @item Create a smart viewing command named @command{open}
1023 This would search for some way to open its argument (similar to opening
1024 a file in the Windows Explorer).
1026 @item Alias @command{read} to be the same as @command{open}, only read-only
1028 @item Write a @command{tail} command which uses @code{view-file}
1030 It would move point to the end of the buffer, and then turns on
1031 auto-revert mode in that buffer at frequent intervals---and a
1032 @command{head} alias which assums an upper limit of
1033 @code{eshell-maximum-line-length} characters per line.
1035 @item Make @command{dgrep} load @code{dired}, mark everything, then invoke @code{dired-do-search}
1037 @item Write mesh.c
1039 This would run Emacs with the appropriate arguments to invoke Eshell
1040 only.  That way, it could be listed as a login shell.
1042 @item Use an intangible @code{PS2} string for multi-line input prompts
1044 @item Auto-detect when a command is visual, by checking @code{TERMCAP} usage
1046 @item The first keypress after @kbd{M-x watson} triggers `eshell-send-input'
1048 @item Make @kbd{/} electric
1050 So that it automatically expands and corrects pathnames.  Or make
1051 pathname completion for Pcomplete auto-expand @samp{/u/i/std<TAB>} to
1052 @samp{/usr/include/std<TAB>}.
1054 @item Write the @command{pushd} stack to disk along with @code{last-dir-ring}
1056 @item Add options to @code{eshell/cat} which would allow it to sort and uniq
1058 @item Implement @command{wc} in Lisp
1060 Add support for counting sentences, paragraphs, pages, etc.
1062 @item Once piping is added, implement @command{sort} and @command{uniq} in Lisp
1064 @item Implement @command{touch} in Lisp
1066 @item Implement @command{comm} in Lisp
1068 @item Implement an @command{epatch} command in Lisp
1070 This would call @code{ediff-patch-file}, or @code{ediff-patch-buffer},
1071 depending on its argument.
1073 @item Have an option such that @samp{ls -l} generates a dired buffer
1075 @item Write a version of @command{xargs} based on command rewriting
1077 That is, @samp{find X | xargs Y} would be indicated using @samp{Y
1078 $@{find X@}}.  Maybe @code{eshell-do-pipelines} could be changed to
1079 perform this on-thy-fly rewriting.
1081 @item Write an alias for @command{less} that brings up a @code{view-mode} buffer
1083 Such that the user can press @key{SPC} and @key{DEL}, and then @key{q}
1084 to return to Eshell.  It would be equivalent to: 
1085 @samp{X > #<buffer Y>; view-buffer #<buffer Y>}.
1087 @item Make @code{eshell-mode} as much a full citizen as @code{shell-mode}
1089 Everywhere in Emacs where @code{shell-mode} is specially noticed, add
1090 @code{eshell-mode} there.
1092 @item Permit the umask to be selectively set on a @command{cp} target
1094 @item Problem using @kbd{M-x eshell} after using @code{eshell-command}
1096 If the first thing that I do after entering Emacs is to run
1097 @code{eshell-command} and invoke @command{ls}, and then use @kbd{M-x
1098 eshell}, it doesn't display anything.
1100 @item @kbd{M-RET} during a long command (using smart display) doesn't work
1102 Since it keeps the cursor up where the command was invoked.
1104 @end table
1106 @node Concept Index, Function and Variable Index, Bugs and ideas, Top
1107 @unnumbered Concept Index
1109 @printindex cp
1111 @node Function and Variable Index, Key Index, Concept Index, Top
1112 @unnumbered Function and Variable Index
1114 @printindex fn
1116 @node Key Index,  , Function and Variable Index, Top
1117 @unnumbered Key Index
1119 @printindex ky
1120 @bye