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