* insdel.c (prepare_to_modify_buffer): Force redisplay if
[emacs.git] / doc / misc / eshell.texi
blob504940c5c6b8504c7703ac68a6667bcf1a87c22a
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename ../../info/eshell
4 @settitle Eshell: The Emacs Shell
5 @synindex vr fn
6 @c %**end of header
8 @copying
9 This manual is for Eshell, the Emacs shell.
11 Copyright @copyright{} 1999--2013 Free Software Foundation, Inc.
13 @quotation
14 Permission is granted to copy, distribute and/or modify this document
15 under the terms of the GNU Free Documentation License, Version 1.3 or
16 any later version published by the Free Software Foundation; with no
17 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
18 and with the Back-Cover Texts as in (a) below.  A copy of the license
19 is included in the section entitled ``GNU Free Documentation License''.
21 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
22 modify this GNU manual.''
23 @end quotation
24 @end copying
26 @dircategory Emacs misc features
27 @direntry
28 * Eshell: (eshell).             A command shell implemented in Emacs Lisp.
29 @end direntry
31 @titlepage
32 @sp 4
33 @c The title is printed in a large font.
34 @center @titlefont{User's Guide}
35 @sp 1
36 @center @titlefont{to}
37 @sp 1
38 @center @titlefont{Eshell: The Emacs Shell}
39 @ignore
40 @sp 2
41 @center release 2.4
42 @c -release-
43 @end ignore
44 @sp 3
45 @center John Wiegley
46 @c -date-
48 @page
49 @vskip 0pt plus 1filll
50 @insertcopying
51 @end titlepage
53 @contents
55 @c ================================================================
56 @c                   The real text starts here
57 @c ================================================================
59 @ifnottex
60 @node Top
61 @top Eshell
63 Eshell is a shell-like command interpreter
64 implemented in Emacs Lisp.  It invokes no external processes except for
65 those requested by the user.  It is intended to be a functional
66 replacement for command shells such as @command{bash}, @command{zsh},
67 @command{rc}, or @command{4dos}; since Emacs itself is capable of
68 handling the sort of tasks accomplished by those tools.
69 @c This manual is updated to release 2.4 of Eshell.
71 @insertcopying
72 @end ifnottex
74 @menu
75 * What is Eshell?::             A brief introduction to the Emacs Shell.
76 * Command basics::              The basics of command usage.
77 * Commands::
78 * Arguments::
79 * Input/Output::
80 * Process control::
81 * Extension modules::
82 * Extras and Goodies::
83 * Bugs and ideas::              Known problems, and future ideas.
84 * GNU Free Documentation License:: The license for this documentation.
85 * Concept Index::
86 * Function and Variable Index::
87 * Key Index::
88 @end menu
90 @node What is Eshell?
91 @chapter What is Eshell?
92 @cindex what is Eshell?
93 @cindex Eshell, what it is
95 Eshell is a @dfn{command shell} written in Emacs Lisp.  Everything it
96 does, it uses Emacs's facilities to do.  This means that Eshell is as
97 portable as Emacs itself.  It also means that cooperation with Lisp code
98 is natural and seamless.
100 What is a command shell?  To properly understand the role of a shell,
101 it's necessary to visualize what a computer does for you.  Basically, a
102 computer is a tool; in order to use that tool, you must tell it what to
103 do---or give it ``commands.''  These commands take many forms, such as
104 clicking with a mouse on certain parts of the screen.  But that is only
105 one form of command input.
107 By far the most versatile way to express what you want the computer to
108 do is by using an abbreviated language called @dfn{script}.  In
109 script, instead of telling the computer, ``list my files, please'',
110 one writes a standard abbreviated command word---@samp{ls}.  Typing
111 @samp{ls} in a command shell is a script way of telling the computer
112 to list your files.@footnote{This is comparable to viewing the
113 contents of a folder using a graphical display.}
115 The real flexibility of this approach is apparent only when you realize
116 that there are many, many different ways to list files.  Perhaps you
117 want them sorted by name, sorted by date, in reverse order, or grouped
118 by type.  Most graphical browsers have simple ways to express this.  But
119 what about showing only a few files, or only files that meet a certain
120 criteria?  In very complex and specific situations, the request becomes
121 too difficult to express using a mouse or pointing device.  It is just
122 these kinds of requests that are easily solved using a command shell.
124 For example, what if you want to list every Word file on your hard
125 drive, larger than 100 kilobytes in size, and which hasn't been looked
126 at in over six months?  That is a good candidate list for deletion, when
127 you go to clean up your hard drive.  But have you ever tried asking your
128 computer for such a list?  There is no way to do it!  At least, not
129 without using a command shell.
131 The role of a command shell is to give you more control over what your
132 computer does for you.  Not everyone needs this amount of control, and
133 it does come at a cost: Learning the necessary script commands to
134 express what you want done.  A complicated query, such as the example
135 above, takes time to learn.  But if you find yourself using your
136 computer frequently enough, it is more than worthwhile in the long run.
137 Any tool you use often deserves the time spent learning to master it.
138 @footnote{For the understandably curious, here is what that command
139 looks like: But don't let it fool you; once you know what's going on,
140 it's easier than it looks: @code{ls -lt **/*.doc(Lk+50aM+5)}.}
142 @menu
143 * Contributors to Eshell::      People who have helped out!
144 @end menu
146 @node Contributors to Eshell
147 @section Contributors to Eshell
148 @cindex contributors
149 @cindex authors
151 Contributions to Eshell are welcome.  I have limited time to work on
152 this project, but I will gladly add any code you contribute to me to
153 this package.
155 The following persons have made contributions to Eshell.
157 @itemize @bullet
158 @item
159 Eli Zaretskii made it possible for Eshell to run without requiring
160 asynchronous subprocess support.  This is important for MS-DOS, which
161 does not have such support.@refill
163 @item
164 Miles Bader contributed many fixes during the port to Emacs 21.@refill
166 @item
167 Stefan Monnier fixed the things which bothered him, which of course made
168 things better for all.@refill
170 @item
171 Gerd Moellmann also helped to contribute bug fixes during the initial
172 integration with Emacs 21.@refill
174 @item
175 Alex Schroeder contributed code for interactively querying the user
176 before overwriting files.@refill
178 @item
179 Sudish Joseph helped with some XEmacs compatibility issues.@refill
180 @end itemize
182 Apart from these, a lot of people have sent suggestions, ideas,
183 requests, bug reports and encouragement.  Thanks a lot!  Without you
184 there would be no new releases of Eshell.
186 @node Command basics
187 @chapter Basic overview
189 A command shell is a means of entering verbally-formed commands.  This
190 is really all that it does, and every feature described in this manual
191 is a means to that end.  Therefore, it's important to take firm hold on
192 exactly what a command is, and how it fits in the overall picture of
193 things.
195 @menu
196 * Commands verbs::              Commands always begin with a verb.
197 * Command arguments::           Some verbs require arguments.
198 @end menu
200 @node Commands verbs
201 @section Commands verbs
203 Commands are expressed using @dfn{script}, a special shorthand language
204 computers can understand with no trouble.  Script is an extremely simple
205 language; oddly enough, this is what makes it look so complicated!
206 Whereas normal languages use a variety of embellishments, the form of a
207 script command is always:
209 @example
210 @var{verb} [@var{arguments}]
211 @end example
213 The verb expresses what you want your computer to do.  There are a fixed
214 number of verbs, although this number is usually quite large.  On the
215 author's computer, it reaches almost 1400 in number.  But of course,
216 only a handful of these are really necessary.
218 Sometimes, the verb is all that's written.  A verb is always a single
219 word, usually related to the task it performs.  @command{reboot} is a
220 good example.  Entering that on GNU/Linux will reboot the
221 computer---assuming you have sufficient privileges.
223 Other verbs require more information.  These are usually very capable
224 verbs, and must be told specifically what to do.  The extra information
225 is given in the form of @dfn{arguments}.  For example, the
226 @command{echo} verb prints back whatever arguments you type.  It
227 requires these arguments to know what to echo.  A proper use of
228 @command{echo} looks like this:
230 @example
231 echo This is an example of using echo!
232 @end example
234 This script command causes the computer to echo back: ``This is an
235 example of using echo!''
237 Although command verbs are always simple words, like @command{reboot} or
238 @command{echo}, arguments may have a wide variety of forms.  There are
239 textual arguments, numerical arguments---even Lisp arguments.
240 Distinguishing these different types of arguments requires special
241 typing, for the computer to know exactly what you mean.
243 @node Command arguments
244 @section Command arguments
246 Eshell recognizes several different kinds of command arguments:
248 @enumerate
249 @item Strings (also called textual arguments)
250 @item Numbers (floating point or integer)
251 @item Lisp lists
252 @item Lisp symbols
253 @item Emacs buffers
254 @item Emacs process handles
255 @end enumerate
257 Most users need to worry only about the first two.  The third, Lisp lists,
258 occur very frequently, but almost always behind the scenes.
260 Strings are the most common type of argument, and consist of nearly any
261 character.  Special characters---those used by Eshell
262 specifically---must be preceded by a backslash (@samp{\}).  When in doubt, it
263 is safe to add backslashes anywhere and everywhere.
265 Here is a more complicated @command{echo} example:
267 @example
268 echo A\ Multi-word\ Argument\ With\ A\ \$\ dollar
269 @end example
271 Beyond this, things get a bit more complicated.  While not beyond the
272 reach of someone wishing to learn, it is definitely beyond the scope of
273 this manual to present it all in a simplistic manner.  Get comfortable
274 with Eshell as a basic command invocation tool, and learn more about the
275 commands on your system; then come back when it all sits more familiarly
276 on your mind.  Have fun!
278 @node Commands
279 @chapter Commands
281 @menu
282 * Invocation::
283 * Completion::
284 * Aliases::
285 * History::
286 * Scripts::
287 * Built-ins::
288 @end menu
290 Essentially, a command shell is all about invoking commands---and
291 everything that entails.  So understanding how Eshell invokes commands
292 is the key to comprehending how it all works.
294 @node Invocation
295 @section Invocation
297 Unlike regular system shells, Eshell never invokes kernel functions
298 directly, such as @code{exec(3)}.  Instead, it uses the Lisp functions
299 available in the Emacs Lisp library.  It does this by transforming the
300 command you specify into a callable Lisp form.@footnote{To see the Lisp
301 form that will be invoked, type: @samp{eshell-parse-command "echo
302 hello"}}
304 This transformation, from the string of text typed at the command
305 prompt, to the ultimate invocation of either a Lisp function or external
306 command, follows these steps:
308 @enumerate
309 @item Parse the command string into separate arguments.
310 @item
311 @end enumerate
313 @node Completion
314 @section Completion
316 @node Aliases
317 @section Aliases
319 @node History
320 @section History
322 Eshell knows a few built-in variables:
324 @table @code
326 @item $+
327 @vindex $+
328 This variable always contains the current working directory.
330 @item $-
331 @vindex $-
332 This variable always contains the previous working directory (the
333 current working directory from before the last @code{cd} command).
335 @item $_
336 @vindex $_
337 It refers to the last argument of the last command.
339 @item $$
340 @vindex $$
341 This is the result of the last command.  In case of an external
342 command, it is @code{t} or @code{nil}.
344 @item $?
345 @vindex $?
346 This variable contains the exit code of the last command (0 or 1 for
347 Lisp functions, based on successful completion).
349 @end table
351 @node Scripts
352 @section Scripts
355 @node Built-ins
356 @section Built-in commands
358 Several commands are built-in in Eshell.  In order to call the
359 external variant of a built-in command @code{foo}, you could call
360 @code{*foo}.  Usually, this should not be necessary.  You can check
361 what will be applied by the @code{which} command:
363 @example
364 ~ $ which ls
365 eshell/ls is a compiled Lisp function in `em-ls.el'
366 ~ $ which *ls
367 /bin/ls
368 @end example
370 If you want to discard a given built-in command, you could declare an
371 alias, @ref{Aliases}.  Eample:
373 @example
374 ~ $ which sudo
375 eshell/sudo is a compiled Lisp function in `em-unix.el'
376 ~ $ alias sudo '*sudo $*'
377 ~ $ which sudo
378 sudo is an alias, defined as "*sudo $*"
379 @end example
381 Some of the built-in commands have a special behavior in Eshell:
383 @table @code
385 @item cd
386 @findex cd
387 This command changes the current working directory.  Usually, it is
388 invoked as @samp{cd foo} where @file{foo} is the new working
389 directory.  But @code{cd} knows about a few special arguments:
391 When it receives no argument at all, it changes to the home directory.
393 Giving the command @samp{cd -} changes back to the previous working
394 directory (this is the same as @samp{cd $-}).
396 The command @samp{cd =} shows the directory stack.  Each line is
397 numbered.
399 With @samp{cd =foo}, Eshell searches the directory stack for a
400 directory matching the regular expression @samp{foo} and changes to
401 that directory.
403 With @samp{cd -42}, you can access the directory stack by number.
405 @item history
406 @findex history
407 The @samp{history} command shows all commands kept in the history ring
408 as numbered list.  If the history ring contains
409 @code{eshell-history-size} commands, those numbers change after every
410 command invocation, therefore the @samp{history} command shall be
411 applied before using the expansion mechanism with history numbers.
413 The n-th entry of the history ring can be applied with the @samp{!n}
414 command.  If @code{n} is negative, the entry is counted from the end
415 of the history ring.
417 @samp{!foo} expands to the last command beginning with @code{foo}, and
418 @samp{!?foo} to the last command containing @code{foo}.  The n-th
419 argument of the last command beginning with @code{foo} is accessible
420 by @code{!foo:n}.
422 @item su
423 @findex su
424 @itemx sudo
425 @findex sudo
426 @code{su} and @code{sudo} work as expected: they apply the following
427 commands (@code{su}), or the command being an argument (@code{sudo})
428 under the permissions of somebody else.
430 This does not work only on
431 the local host, but even on a remote one, when
432 @code{default-directory} is a remote file name.  The necessary
433 proxy configuration of Tramp is performed
434 @ifinfo
435 automatically, @ref{Multi-hops, , , tramp}.
436 @end ifinfo
437 @ifnotinfo
438 automatically.
439 @end ifnotinfo
440 Example:
442 @example
443 ~ $ cd /ssh:otherhost:/etc
444 /ssh:user@@otherhost:/etc $ sudo find-file shadow
445 @end example
447 @end table
450 @node Arguments
451 @chapter Arguments
453 @menu
454 * The Parser::
455 * Variables::
456 * Substitution::
457 * Globbing::
458 * Predicates::
459 @end menu
461 @node The Parser
462 @section The Parser
464 @node Variables
465 @section Variables
467 @node Substitution
468 @section Substitution
470 @node Globbing
471 @section Globbing
473 @node Predicates
474 @section Predicates
477 @node Input/Output
478 @chapter Input/Output
480 @node Process control
481 @chapter Process control
484 @node Extension modules
485 @chapter Extension modules
487 @menu
488 * Writing a module::
489 * Module testing::
490 * Directory handling::
491 * Key rebinding::
492 * Smart scrolling::
493 * Terminal emulation::
494 * Built-in UNIX commands::
495 @end menu
497 @node Writing a module
498 @section Writing a module
500 @node Module testing
501 @section Module testing
503 @node Directory handling
504 @section Directory handling
506 @node Key rebinding
507 @section Key rebinding
509 @node Smart scrolling
510 @section Smart scrolling
512 @node Terminal emulation
513 @section Terminal emulation
515 @node Built-in UNIX commands
516 @section Built-in UNIX commands
519 @node Extras and Goodies
520 @chapter Extras and Goodies
522 @node Bugs and ideas
523 @chapter Bugs and ideas
524 @cindex reporting bugs and ideas
525 @cindex bugs, how to report them
526 @cindex author, how to reach
527 @cindex email to the author
528 @cindex FAQ
529 @cindex problems, list of common
531 If you find a bug or misfeature, don't hesitate to let me know!  Send
532 email to @email{johnw@@gnu.org}.  Feature requests should also be sent
533 there.  I prefer discussing one thing at a time.  If you find several
534 unrelated bugs, please report them separately.
536 If you have ideas for improvements, or if you have written some
537 extensions to this package, I would like to hear from you.  I hope you
538 find this package useful!
540 @menu
541 * Known problems::
542 @end menu
544 @node Known problems
545 @section Known problems
546 @cindex known bugs
547 @cindex bugs, known
549 Below is complete list of known problems with Eshell version 2.4.2,
550 which is the version included with Emacs 22.
552 @table @asis
553 @item Documentation incomplete
555 @item Differentiate between aliases and functions
557 Allow for a bash-compatible syntax, such as:
559 @example
560 alias arg=blah
561 function arg () @{ blah $* @}
562 @end example
564 @item @samp{for i in 1 2 3 @{ grep -q a b && *echo has it @} | wc -l} outputs result after prompt
566 In fact, piping to a process from a looping construct doesn't work in
567 general.  If I change the call to @code{eshell-copy-handles} in
568 @code{eshell-rewrite-for-command} to use @code{eshell-protect}, it seems
569 to work, but the output occurs after the prompt is displayed.  The whole
570 structured command thing is too complicated at present.
572 @item Error with @command{bc} in @code{eshell-test}
574 On some XEmacs system, the subprocess interaction test fails
575 inexplicably, although @command{bc} works fine at the command prompt.
577 @item Eshell does not delete @file{*Help*} buffers in XEmacs 21.1.8+
579 In XEmacs 21.1.8, the @file{*Help*} buffer has been renamed such that
580 multiple instances of the @file{*Help*} buffer can exist.
582 @item Pcomplete sometimes gets stuck
584 You press @key{TAB}, but no completions appear, even though the
585 directory has matching files.  This behavior is rare.
587 @item @samp{grep python $<rpm -qa>} doesn't work, but using @samp{*grep} does
589 This happens because the @code{grep} Lisp function returns immediately,
590 and then the asynchronous @command{grep} process expects to examine the
591 temporary file, which has since been deleted.
593 @item Problem with C-r repeating text
595 If the text @emph{before point} reads "./run", and you type @kbd{C-r r u
596 n}, it will repeat the line for every character typed.
598 @item Backspace doesn't scroll back after continuing (in smart mode)
600 Hitting space during a process invocation, such as @command{make}, will
601 cause it to track the bottom of the output; but backspace no longer
602 scrolls back.
604 @item It's not possible to fully @code{unload-feature} Eshell
606 @item Menu support was removed, but never put back
608 @item Using C-p and C-n with rebind gets into a locked state
610 This happened a few times in Emacs 21, but has been irreproducible
611 since.
613 @item If an interactive process is currently running, @kbd{M-!} doesn't work
615 @item Use a timer instead of @code{sleep-for} when killing child processes
617 @item Piping to a Lisp function is not supported
619 Make it so that the Lisp command on the right of the pipe is repeatedly
620 called with the input strings as arguments.  This will require changing
621 @code{eshell-do-pipeline} to handle non-process targets.
623 @item Input redirection is not supported
625 See the above entry.
627 @item Problem running @command{less} without arguments on Windows
629 The result in the Eshell buffer is:
631 @example
632 Spawning child process: invalid argument
633 @end example
635 Also a new @command{less} buffer was created with nothing in it@dots{}
636 (presumably this holds the output of @command{less}).
638 If @command{less.exe} is invoked from the Eshell command line, the
639 expected output is written to the buffer.
641 Note that this happens on NT-Emacs 20.6.1 on Windows 2000. The term.el
642 package and the supplied shell both use the @command{cmdproxy} program
643 for running shells.
645 @item Implement @samp{-r}, @samp{-n} and @samp{-s} switches for @command{cp}
647 @item Make @kbd{M-5 M-x eshell} switch to ``*eshell<5>*'', creating if need be
649 @item @samp{mv @var{dir} @var{file}.tar} does not remove directories
651 This is because the tar option --remove-files doesn't do so.  Should it
652 be Eshell's job?
654 @item Bind @code{standard-output} and @code{standard-error}
656 This would be so that if a Lisp function calls @code{print}, everything
657 will happen as it should (albeit slowly).
659 @item When an extension module fails to load, @samp{cd /} gives a Lisp error
661 @item If a globbing pattern returns one match, should it be a list?
663 @item Make sure syntax table is correct in Eshell mode
665 So that @kbd{M-DEL} acts in a predictable manner, etc.
667 @item Allow all Eshell buffers to share the same history and list-dir
669 @item There is a problem with script commands that output to @file{/dev/null}
671 If a script file, somewhere in the middle, uses @samp{> /dev/null},
672 output from all subsequent commands is swallowed.
674 @item Split up parsing of text after @samp{$} in @file{esh-var.el}
676 Make it similar to the way that @file{esh-arg.el} is structured.
677 Then add parsing of @samp{$[?\n]}.
679 @item After pressing @kbd{M-RET}, redisplay before running the next command
681 @item Argument predicates and modifiers should work anywhere in a path
683 @example
684 /usr/local/src/editors/vim $ vi **/CVS(/)/Root(.)
685 Invalid regexp: "Unmatched ( or \\("
686 @end example
688 With @command{zsh}, the glob above expands to all files named
689 @file{Root} in directories named @file{CVS}.
691 @item Typing @samp{echo $@{locate locate@}/bin<TAB>} results in a Lisp error
693 Perhaps it should interpolate all permutations, and make that the
694 globbing result, since otherwise hitting return here will result in
695 ``(list of filenames)/bin'', which is never valuable.  Thus, one could
696 @command{cat} only C backup files by using @samp{ls $@{identity *.c@}~}.
697 In that case, having an alias command name @command{glob} for
698 @command{identity} would be useful.
700 @item Once symbolic mode is supported for @command{umask}, implement @command{chmod} in Lisp
702 @item Create @code{eshell-expand-file-name}
704 This would use a data table to transform things such as @samp{~+},
705 @samp{...}, etc.
707 @item Abstract @file{em-smart.el} into @file{smart-scroll.el}
709 It only really needs: to be hooked onto the output filter and the
710 pre-command hook, and to have the input-end and input-start markers.
711 And to know whether the last output group was ``successful.''
713 @item Allow for fully persisting the state of Eshell
715 This would include: variables, history, buffer, input, dir stack, etc.
717 @item Implement D as an argument predicate
719 It means that files beginning with a dot should be included in the
720 glob match.
722 @item A comma in a predicate list should mean OR
724 At the moment, this is not supported.
726 @item Error if a glob doesn't expand due to a predicate
728 An error should be generated only if @code{eshell-error-if-no-glob} is
729 non-@code{nil}.
731 @item @samp{(+ RET SPC TAB} does not cause @code{indent-according-to-mode} to occur
733 @item Create @code{eshell-auto-accumulate-list}
735 This is a list of commands for which, if the user presses @kbd{RET}, the
736 text is staged as the next Eshell command, rather than being sent to the
737 current interactive process.
739 @item Display file and line number if an error occurs in a script
741 @item @command{wait} doesn't work with process ids at the moment
743 @item Enable the direct-to-process input code in @file{em-term.el}
745 @item Problem with repeating @samp{echo $@{find /tmp@}}
747 With smart display active, if @kbd{RET} is held down, after a while it
748 can't keep up anymore and starts outputting blank lines.  It only
749 happens if an asynchronous process is involved@dots{}
751 I think the problem is that @code{eshell-send-input} is resetting the
752 input target location, so that if the asynchronous process is not done
753 by the time the next @kbd{RET} is received, the input processor thinks
754 that the input is meant for the process; which, when smart display is
755 enabled, will be the text of the last command line!  That is a bug in
756 itself.
758 In holding down @kbd{RET} while an asynchronous process is running,
759 there will be a point in between termination of the process, and the
760 running of @code{eshell-post-command-hook}, which would cause
761 @code{eshell-send-input} to call @code{eshell-copy-old-input}, and then
762 process that text as a command to be run after the process.  Perhaps
763 there should be a way of killing pending input between the death of the
764 process, and the @code{post-command-hook}.
766 @item Allow for a more aggressive smart display mode
768 Perhaps toggled by a command, that makes each output block a smart
769 display block.
771 @item Create more meta variables
773 @table @samp
774 @item $!
775 The reason for the failure of the last disk command, or the text of the
776 last Lisp error.
778 @item $=
779 A special associate array, which can take references of the form
780 @samp{$=[REGEXP]}.  It indexes into the directory ring.
781 @end table
783 @item Eshell scripts can't execute in the background
785 @item Support zsh's ``Parameter Expansion'' syntax, i.e., @samp{$@{@var{name}:-@var{val}@}}
787 @item Write an @command{info} alias that can take arguments
789 So that the user can enter @samp{info chmod}, for example.
791 @item Create a mode @code{eshell-browse}
793 It would treat the Eshell buffer as a outline.  Collapsing the outline
794 hides all of the output text.  Collapsing again would show only the
795 first command run in each directory
797 @item Allow other revisions of a file to be referenced using @samp{file@{rev@}}
799 This would be expanded by @code{eshell-expand-file-name} (see above).
801 @item Print ``You have new mail'' when the ``Mail'' icon is turned on
803 @item Implement @kbd{M-|} for Eshell
805 @item Implement input redirection
807 If it's a Lisp function, input redirection implies @command{xargs} (in a
808 way@dots{}).  If input redirection is added, also update the
809 @code{file-name-quote-list}, and the delimiter list.
811 @item Allow @samp{#<@var{word} @var{arg}>} as a generic syntax
813 With the handling of @emph{word} specified by an
814 @code{eshell-special-alist}.
816 @item In @code{eshell-eval-using-options}, allow a @code{:complete} tag
818 It would be used to provide completion rules for that command.  Then the
819 macro will automagically define the completion function.
821 @item For @code{eshell-command-on-region}, apply redirections to the result
823 So that @samp{+ > 'blah} would cause the result of the @code{+} (using
824 input from the current region) to be inserting into the symbol
825 @code{blah}.
827 If an external command is being invoked, the input is sent as standard
828 input, as if a @samp{cat <region> |} had been invoked.
830 If a Lisp command, or an alias, is invoked, then if the line has no
831 newline characters, it is divided by whitespace and passed as arguments
832 to the Lisp function.  Otherwise, it is divided at the newline
833 characters.  Thus, invoking @code{+} on a series of numbers will add
834 them; @code{min} would display the smallest figure, etc.
836 @item Write @code{eshell-script-mode} as a minor mode
838 It would provide syntax, abbrev, highlighting and indenting support like
839 @code{emacs-lisp-mode} and @code{shell-mode}.
841 @item In the history mechanism, finish the @command{bash}-style support
843 This means @samp{!n}, @samp{!#}, @samp{!:%}, and @samp{!:1-} as separate
844 from @samp{!:1*}.
846 @item Support the -n command line option for @command{history}
848 @item Implement @command{fc} in Lisp
850 @item Specifying a frame as a redirection target should imply the currently active window's buffer
852 @item Implement @samp{>@var{func-or-func-list}}
854 This would allow for an ``output translators'', that take a function to
855 modify output with, and a target.  Devise a syntax that works well with
856 pipes, and can accommodate multiple functions (i.e., @samp{>'(upcase
857 regexp-quote)} or @samp{>'upcase}).
859 @item Allow Eshell to read/write to/from standard input and output
861 This would be optional, rather than always using the Eshell buffer.
862 This would allow it to be run from the command line (perhaps).
864 @item Write a @command{help} command
866 It would call subcommands with @option{--help}, or @option{-h} or
867 @option{/?}, as appropriate.
869 @item Implement @command{stty} in Lisp
871 @item Support @command{rc}'s matching operator, e.g., @samp{~ (@var{list}) @var{regexp}}
873 @item Implement @command{bg} and @command{fg} as editors of @code{eshell-process-list}
875 Using @command{bg} on a process that is already in the background does
876 nothing.  Specifying redirection targets replaces (or adds) to the list
877 current being used.
879 @item Have @command{jobs} print only the processes for the current shell
881 @item How can Eshell learn if a background process has requested input?
883 @item Support @samp{2>&1} and @samp{>&} and @samp{2>} and @samp{|&}
885 The syntax table for parsing these should be customizable, such that the
886 user could change it to use rc syntax: @samp{>[2=1]}.
888 @item Allow @samp{$_[-1]}, which would indicate the last element of the array
890 @item Make @samp{$x[*]} equal to listing out the full contents of @samp{x}
892 Return them as a list, so that @samp{$_[*]} is all the arguments of the
893 last command.
895 @item Copy ANSI code handling from @file{term.el} into @file{em-term.el}
897 Make it possible for the user to send char-by-char to the underlying
898 process.  Ultimately, I should be able to move away from using term.el
899 altogether, since everything but the ANSI code handling is already part
900 of Eshell.  Then, things would work correctly on MS-Windows as well
901 (which doesn't have @file{/bin/sh}, although @file{term.el} tries to use
902 it).
904 @item Make the shell spawning commands be visual
906 That is, make (@command{su}, @command{bash}, @command{telnet},
907 @command{rlogin}, @command{rsh}, etc.) be part of
908 @code{eshell-visual-commands}.  The only exception is if the shell is
909 being used to invoke a single command.  Then, the behavior should be
910 based on what that command is.
912 @item Create a smart viewing command named @command{open}
914 This would search for some way to open its argument (similar to opening
915 a file in the Windows Explorer).
917 @item Alias @command{read} to be the same as @command{open}, only read-only
919 @item Write a @command{tail} command which uses @code{view-file}
921 It would move point to the end of the buffer, and then turns on
922 auto-revert mode in that buffer at frequent intervals---and a
923 @command{head} alias which assumes an upper limit of
924 @code{eshell-maximum-line-length} characters per line.
926 @item Make @command{dgrep} load @code{dired}, mark everything, then invoke @code{dired-do-search}
928 @item Write mesh.c
930 This would run Emacs with the appropriate arguments to invoke Eshell
931 only.  That way, it could be listed as a login shell.
933 @item Use an intangible @code{PS2} string for multi-line input prompts
935 @item Auto-detect when a command is visual, by checking @code{TERMCAP} usage
937 @item The first keypress after @kbd{M-x watson} triggers `eshell-send-input'
939 @item Make @kbd{/} electric
941 So that it automatically expands and corrects pathnames.  Or make
942 pathname completion for Pcomplete auto-expand @samp{/u/i/std<TAB>} to
943 @samp{/usr/include/std<TAB>}.
945 @item Write the @command{pushd} stack to disk along with @code{last-dir-ring}
947 @item Add options to @code{eshell/cat} which would allow it to sort and uniq
949 @item Implement @command{wc} in Lisp
951 Add support for counting sentences, paragraphs, pages, etc.
953 @item Once piping is added, implement @command{sort} and @command{uniq} in Lisp
955 @item Implement @command{touch} in Lisp
957 @item Implement @command{comm} in Lisp
959 @item Implement an @command{epatch} command in Lisp
961 This would call @code{ediff-patch-file}, or @code{ediff-patch-buffer},
962 depending on its argument.
964 @item Have an option such that @samp{ls -l} generates a dired buffer
966 @item Write a version of @command{xargs} based on command rewriting
968 That is, @samp{find X | xargs Y} would be indicated using @samp{Y
969 $@{find X@}}.  Maybe @code{eshell-do-pipelines} could be changed to
970 perform this on-thy-fly rewriting.
972 @item Write an alias for @command{less} that brings up a @code{view-mode} buffer
974 Such that the user can press @key{SPC} and @key{DEL}, and then @key{q}
975 to return to Eshell.  It would be equivalent to:
976 @samp{X > #<buffer Y>; view-buffer #<buffer Y>}.
978 @item Make @code{eshell-mode} as much a full citizen as @code{shell-mode}
980 Everywhere in Emacs where @code{shell-mode} is specially noticed, add
981 @code{eshell-mode} there.
983 @item Permit the umask to be selectively set on a @command{cp} target
985 @item Problem using @kbd{M-x eshell} after using @code{eshell-command}
987 If the first thing that I do after entering Emacs is to run
988 @code{eshell-command} and invoke @command{ls}, and then use @kbd{M-x
989 eshell}, it doesn't display anything.
991 @item @kbd{M-RET} during a long command (using smart display) doesn't work
993 Since it keeps the cursor up where the command was invoked.
995 @end table
997 @node GNU Free Documentation License
998 @appendix GNU Free Documentation License
999 @include doclicense.texi
1001 @node Concept Index
1002 @unnumbered Concept Index
1004 @printindex cp
1006 @node Function and Variable Index
1007 @unnumbered Function and Variable Index
1009 @printindex fn
1011 @node Key Index
1012 @unnumbered Key Index
1014 @printindex ky
1015 @bye