aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorAidan Gauland2013-02-19 07:27:51 +1300
committerAidan Gauland2013-02-19 07:27:51 +1300
commit6a0fda530d1d76374f72f8dfb2a0a3d50023e64d (patch)
treec086c298102b60b7407acab4306b531beb7560f2 /doc/misc
parent587feed443522f738b65b57b22a31cc8a25525c5 (diff)
downloademacs-6a0fda530d1d76374f72f8dfb2a0a3d50023e64d.tar.gz
emacs-6a0fda530d1d76374f72f8dfb2a0a3d50023e64d.zip
Documented Eshell's insert output-redirection operator
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/eshell.texi17
1 files changed, 12 insertions, 5 deletions
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
711Redirection is mostly the same in Eshell as it is in other command 711Redirection is mostly the same in Eshell as it is in other command
712shells. The output redirection operators @code{>} and @code{>>} as well 712shells. The output redirection operators @code{>} and @code{>>} as
713as pipes are supported, but there is not yet any support for input 713well as pipes are supported, but there is not yet any support for
714redirection. Output can also be redirected to Elisp functions, using 714input redirection. Output can also be redirected to buffers, using
715the @code{>>>} redirection operator, and Elisp functions, using
715virtual devices. 716virtual devices.
716 717
718The buffer redirection operator, @code{>>>}, expects a buffer object
719on the right-hand side, into which it inserts the output of the
720left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>}
721inserts 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
718names to functions. Eshell comes with two virtual devices: 724names 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
727non-nil, then the function is passed the redirection mode as a 733non-nil, then the function is passed the redirection mode as a
728symbol--@code{overwrite}, @code{append}, or @code{insert}--and the 734symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or
729function is expected to return the output function. 735@code{insert} for @code{>>>}--and the function is expected to return
736the output function.
730 737
731The output function is called once on each line of output until 738The 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.