diff options
| author | Aidan Gauland | 2013-02-19 07:27:51 +1300 |
|---|---|---|
| committer | Aidan Gauland | 2013-02-19 07:27:51 +1300 |
| commit | 6a0fda530d1d76374f72f8dfb2a0a3d50023e64d (patch) | |
| tree | c086c298102b60b7407acab4306b531beb7560f2 | |
| parent | 587feed443522f738b65b57b22a31cc8a25525c5 (diff) | |
| download | emacs-6a0fda530d1d76374f72f8dfb2a0a3d50023e64d.tar.gz emacs-6a0fda530d1d76374f72f8dfb2a0a3d50023e64d.zip | |
Documented Eshell's insert output-redirection operator
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | doc/misc/eshell.texi | 17 |
2 files changed, 17 insertions, 5 deletions
| @@ -1,3 +1,8 @@ | |||
| 1 | 2013-02-18 Aidan Gauland <aidalgol@no8wireless.co.nz> | ||
| 2 | |||
| 3 | * doc/misc/eshell.texi: Added documentation for Eshell insert | ||
| 4 | output redirection operator, >>>. | ||
| 5 | |||
| 1 | 2013-02-15 Paul Eggert <eggert@cs.ucla.edu> | 6 | 2013-02-15 Paul Eggert <eggert@cs.ucla.edu> |
| 2 | 7 | ||
| 3 | Fix AIX port (Bug#13650). | 8 | Fix AIX port (Bug#13650). |
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index 94093dc15ce..3bef6a4595c 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi | |||
| @@ -709,11 +709,17 @@ which commands need to be run in a terminal, add them to the list | |||
| 709 | @var{eshell-visual-commands}. | 709 | @var{eshell-visual-commands}. |
| 710 | 710 | ||
| 711 | Redirection is mostly the same in Eshell as it is in other command | 711 | Redirection is mostly the same in Eshell as it is in other command |
| 712 | shells. The output redirection operators @code{>} and @code{>>} as well | 712 | shells. The output redirection operators @code{>} and @code{>>} as |
| 713 | as pipes are supported, but there is not yet any support for input | 713 | well as pipes are supported, but there is not yet any support for |
| 714 | redirection. Output can also be redirected to Elisp functions, using | 714 | input redirection. Output can also be redirected to buffers, using |
| 715 | the @code{>>>} redirection operator, and Elisp functions, using | ||
| 715 | virtual devices. | 716 | virtual devices. |
| 716 | 717 | ||
| 718 | The buffer redirection operator, @code{>>>}, expects a buffer object | ||
| 719 | on the right-hand side, into which it inserts the output of the | ||
| 720 | left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>} | ||
| 721 | inserts the string @code{"hello"} into the @code{*scratch*} buffer. | ||
| 722 | |||
| 717 | @var{eshell-virtual-targets} is a list of mappings of virtual device | 723 | @var{eshell-virtual-targets} is a list of mappings of virtual device |
| 718 | names to functions. Eshell comes with two virtual devices: | 724 | names to functions. Eshell comes with two virtual devices: |
| 719 | @file{/dev/kill}, which sends the text to the kill ring, and | 725 | @file{/dev/kill}, which sends the text to the kill ring, and |
| @@ -725,8 +731,9 @@ by adding a list of the form @code{("/dev/name" function mode)} to | |||
| 725 | @code{function} may be either a lambda or a function name. If | 731 | @code{function} may be either a lambda or a function name. If |
| 726 | @code{mode} is nil, then the function is the output function; if it is | 732 | @code{mode} is nil, then the function is the output function; if it is |
| 727 | non-nil, then the function is passed the redirection mode as a | 733 | non-nil, then the function is passed the redirection mode as a |
| 728 | symbol--@code{overwrite}, @code{append}, or @code{insert}--and the | 734 | symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or |
| 729 | function is expected to return the output function. | 735 | @code{insert} for @code{>>>}--and the function is expected to return |
| 736 | the output function. | ||
| 730 | 737 | ||
| 731 | The output function is called once on each line of output until | 738 | The output function is called once on each line of output until |
| 732 | @code{nil} is passed, indicating end of output. | 739 | @code{nil} is passed, indicating end of output. |