diff options
Diffstat (limited to 'doc/misc/eshell.texi')
| -rw-r--r-- | doc/misc/eshell.texi | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index 4604b262e72..bbe741a7a1d 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi | |||
| @@ -353,7 +353,7 @@ sudo is an alias, defined as "*sudo $*" | |||
| 353 | 353 | ||
| 354 | @vindex eshell-prefer-lisp-functions | 354 | @vindex eshell-prefer-lisp-functions |
| 355 | If you would prefer to use the built-in commands instead of the external | 355 | If you would prefer to use the built-in commands instead of the external |
| 356 | commands, set @var{eshell-prefer-lisp-functions} to @code{t}. | 356 | commands, set @code{eshell-prefer-lisp-functions} to @code{t}. |
| 357 | 357 | ||
| 358 | Some of the built-in commands have different behaviour from their | 358 | Some of the built-in commands have different behaviour from their |
| 359 | external counterparts, and some have no external counterpart. Most of | 359 | external counterparts, and some have no external counterpart. Most of |
| @@ -515,7 +515,7 @@ Aliases are commands that expand to a longer input line. For example, | |||
| 515 | with the command invocation @samp{alias ll ls -l}; with this defined, | 515 | with the command invocation @samp{alias ll ls -l}; with this defined, |
| 516 | running @samp{ll foo} in Eshell will actually run @samp{ls -l foo}. | 516 | running @samp{ll foo} in Eshell will actually run @samp{ls -l foo}. |
| 517 | Aliases defined (or deleted) by the @command{alias} command are | 517 | Aliases defined (or deleted) by the @command{alias} command are |
| 518 | automatically written to the file named by @var{eshell-aliases-file}, | 518 | automatically written to the file named by @code{eshell-aliases-file}, |
| 519 | which you can also edit directly (although you will have to manually | 519 | which you can also edit directly (although you will have to manually |
| 520 | reload it). | 520 | reload it). |
| 521 | 521 | ||
| @@ -539,7 +539,7 @@ by @code{!foo:n}. | |||
| 539 | 539 | ||
| 540 | The history ring is loaded from a file at the start of every session, | 540 | The history ring is loaded from a file at the start of every session, |
| 541 | and written back to the file at the end of every session. The file path | 541 | and written back to the file at the end of every session. The file path |
| 542 | is specified in @var{eshell-history-file-name}. Unlike other shells, | 542 | is specified in @code{eshell-history-file-name}. Unlike other shells, |
| 543 | such as Bash, Eshell can not be configured to keep a history ring of a | 543 | such as Bash, Eshell can not be configured to keep a history ring of a |
| 544 | different size than that of the history file. | 544 | different size than that of the history file. |
| 545 | 545 | ||
| @@ -721,11 +721,11 @@ terminal emulator. | |||
| 721 | Programs that need a terminal to display output properly are referred | 721 | Programs that need a terminal to display output properly are referred |
| 722 | to in this manual as ``visual commands,'' because they are not simply | 722 | to in this manual as ``visual commands,'' because they are not simply |
| 723 | line-oriented. You must tell Eshell which commands are visual, by | 723 | line-oriented. You must tell Eshell which commands are visual, by |
| 724 | adding them to @var{eshell-visual-commands}; for commands that are | 724 | adding them to @code{eshell-visual-commands}; for commands that are |
| 725 | visual for only certain @emph{sub}-commands -- e.g. @samp{git log} but | 725 | visual for only certain @emph{sub}-commands -- e.g. @samp{git log} but |
| 726 | not @samp{git status} -- use @var{eshell-visual-subcommands}; and for | 726 | not @samp{git status} -- use @code{eshell-visual-subcommands}; and for |
| 727 | commands that are visual only when passed certain options, use | 727 | commands that are visual only when passed certain options, use |
| 728 | @var{eshell-visual-options}. | 728 | @code{eshell-visual-options}. |
| 729 | 729 | ||
| 730 | @section Redirection | 730 | @section Redirection |
| 731 | Redirection is mostly the same in Eshell as it is in other command | 731 | Redirection is mostly the same in Eshell as it is in other command |
| @@ -740,16 +740,16 @@ on the right-hand side, into which it inserts the output of the | |||
| 740 | left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>} | 740 | left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>} |
| 741 | inserts the string @code{"hello"} into the @code{*scratch*} buffer. | 741 | inserts the string @code{"hello"} into the @code{*scratch*} buffer. |
| 742 | 742 | ||
| 743 | @var{eshell-virtual-targets} is a list of mappings of virtual device | 743 | @code{eshell-virtual-targets} is a list of mappings of virtual device |
| 744 | names to functions. Eshell comes with two virtual devices: | 744 | names to functions. Eshell comes with two virtual devices: |
| 745 | @file{/dev/kill}, which sends the text to the kill ring, and | 745 | @file{/dev/kill}, which sends the text to the kill ring, and |
| 746 | @file{/dev/clip}, which sends text to the clipboard. | 746 | @file{/dev/clip}, which sends text to the clipboard. |
| 747 | 747 | ||
| 748 | You can, of course, define your own virtual targets. They are defined | 748 | You can, of course, define your own virtual targets. They are defined |
| 749 | by adding a list of the form @code{("/dev/name" function mode)} to | 749 | by adding a list of the form @samp{("/dev/name" @var{function} @var{mode})} to |
| 750 | @var{eshell-virtual-targets}. The first element is the device name; | 750 | @code{eshell-virtual-targets}. The first element is the device name; |
| 751 | @code{function} may be either a lambda or a function name. If | 751 | @var{function} may be either a lambda or a function name. If |
| 752 | @code{mode} is nil, then the function is the output function; if it is | 752 | @var{mode} is nil, then the function is the output function; if it is |
| 753 | non-nil, then the function is passed the redirection mode as a | 753 | non-nil, then the function is passed the redirection mode as a |
| 754 | symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or | 754 | symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or |
| 755 | @code{insert} for @code{>>>}--and the function is expected to return | 755 | @code{insert} for @code{>>>}--and the function is expected to return |
| @@ -774,7 +774,7 @@ Eshell module.} You also need to load the following as shown: | |||
| 774 | 774 | ||
| 775 | @example | 775 | @example |
| 776 | (eval-when-compile | 776 | (eval-when-compile |
| 777 | (require 'cl) | 777 | (require 'cl-lib) |
| 778 | (require 'esh-mode) | 778 | (require 'esh-mode) |
| 779 | (require 'eshell)) | 779 | (require 'eshell)) |
| 780 | 780 | ||