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