aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/display.texi13
-rw-r--r--doc/misc/ChangeLog4
-rw-r--r--doc/misc/eshell.texi24
3 files changed, 22 insertions, 19 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 2e7d4f4c010..8ebf440c9fe 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -4190,8 +4190,8 @@ variables:
4190 4190
4191@defvar left-margin-width 4191@defvar left-margin-width
4192This variable specifies the width of the left margin, in character 4192This variable specifies the width of the left margin, in character
4193cell units. It is buffer-local in all buffers. A value of @code{nil} 4193cell (a.k.a.@: ``column'') units. It is buffer-local in all buffers.
4194means no left marginal area. 4194A value of @code{nil} means no left marginal area.
4195@end defvar 4195@end defvar
4196 4196
4197@defvar right-margin-width 4197@defvar right-margin-width
@@ -4209,17 +4209,16 @@ Thus, you can make changes take effect by calling
4209 4209
4210@defun set-window-margins window left &optional right 4210@defun set-window-margins window left &optional right
4211This function specifies the margin widths for window @var{window}, in 4211This function specifies the margin widths for window @var{window}, in
4212character cell (a.k.a.@: ``column''), units. The argument @var{left} 4212character cell units. The argument @var{left} controls the left
4213controls the left margin and @var{right} controls the right margin 4213margin, and @var{right} controls the right margin (default @code{0}).
4214(default @code{0}).
4215@end defun 4214@end defun
4216 4215
4217@defun window-margins &optional window 4216@defun window-margins &optional window
4218This function returns the width of the left and right margins of 4217This function returns the width of the left and right margins of
4219@var{window} as a cons cell of the form @w{@code{(@var{left} 4218@var{window} as a cons cell of the form @w{@code{(@var{left}
4220. @var{right})}}. If one of the two marginal areas does not exist, 4219. @var{right})}}. If one of the two marginal areas does not exist,
4221its width is returned as @code{nil}; if none of the two margins exist, 4220its width is returned as @code{nil}; if neither of the two margins exist,
4222the function returns @code{nil}. If @var{window} is @code{nil}, the 4221the function returns @code{(nil)}. If @var{window} is @code{nil}, the
4223selected window is used. 4222selected window is used.
4224@end defun 4223@end defun
4225 4224
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index aa1e69891a2..4a52e2314ca 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,7 @@
12013-09-14 Glenn Morris <rgm@gnu.org>
2
3 * eshell.texi: Markup fixes.
4
12013-09-11 Xue Fuqiao <xfq.free@gmail.com> 52013-09-11 Xue Fuqiao <xfq.free@gmail.com>
2 6
3 * ido.texi (Interactive Substring Matching): Use @key{RET} instead 7 * ido.texi (Interactive Substring Matching): Use @key{RET} instead
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
355If you would prefer to use the built-in commands instead of the external 355If you would prefer to use the built-in commands instead of the external
356commands, set @var{eshell-prefer-lisp-functions} to @code{t}. 356commands, set @code{eshell-prefer-lisp-functions} to @code{t}.
357 357
358Some of the built-in commands have different behaviour from their 358Some of the built-in commands have different behaviour from their
359external counterparts, and some have no external counterpart. Most of 359external 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,
515with the command invocation @samp{alias ll ls -l}; with this defined, 515with the command invocation @samp{alias ll ls -l}; with this defined,
516running @samp{ll foo} in Eshell will actually run @samp{ls -l foo}. 516running @samp{ll foo} in Eshell will actually run @samp{ls -l foo}.
517Aliases defined (or deleted) by the @command{alias} command are 517Aliases defined (or deleted) by the @command{alias} command are
518automatically written to the file named by @var{eshell-aliases-file}, 518automatically written to the file named by @code{eshell-aliases-file},
519which you can also edit directly (although you will have to manually 519which you can also edit directly (although you will have to manually
520reload it). 520reload it).
521 521
@@ -539,7 +539,7 @@ by @code{!foo:n}.
539 539
540The history ring is loaded from a file at the start of every session, 540The history ring is loaded from a file at the start of every session,
541and written back to the file at the end of every session. The file path 541and written back to the file at the end of every session. The file path
542is specified in @var{eshell-history-file-name}. Unlike other shells, 542is specified in @code{eshell-history-file-name}. Unlike other shells,
543such as Bash, Eshell can not be configured to keep a history ring of a 543such as Bash, Eshell can not be configured to keep a history ring of a
544different size than that of the history file. 544different size than that of the history file.
545 545
@@ -721,11 +721,11 @@ terminal emulator.
721Programs that need a terminal to display output properly are referred 721Programs that need a terminal to display output properly are referred
722to in this manual as ``visual commands,'' because they are not simply 722to in this manual as ``visual commands,'' because they are not simply
723line-oriented. You must tell Eshell which commands are visual, by 723line-oriented. You must tell Eshell which commands are visual, by
724adding them to @var{eshell-visual-commands}; for commands that are 724adding them to @code{eshell-visual-commands}; for commands that are
725visual for only certain @emph{sub}-commands -- e.g. @samp{git log} but 725visual for only certain @emph{sub}-commands -- e.g. @samp{git log} but
726not @samp{git status} -- use @var{eshell-visual-subcommands}; and for 726not @samp{git status} -- use @code{eshell-visual-subcommands}; and for
727commands that are visual only when passed certain options, use 727commands 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
731Redirection is mostly the same in Eshell as it is in other command 731Redirection 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
740left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>} 740left-hand side. e.g., @samp{echo hello >>> #<buffer *scratch*>}
741inserts the string @code{"hello"} into the @code{*scratch*} buffer. 741inserts 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
744names to functions. Eshell comes with two virtual devices: 744names 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
748You can, of course, define your own virtual targets. They are defined 748You can, of course, define your own virtual targets. They are defined
749by adding a list of the form @code{("/dev/name" function mode)} to 749by 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
753non-nil, then the function is passed the redirection mode as a 753non-nil, then the function is passed the redirection mode as a
754symbol--@code{overwrite} for @code{>}, @code{append} for @code{>>}, or 754symbol--@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