aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorPaul Eggert2016-01-30 11:43:26 -0800
committerPaul Eggert2016-01-30 11:43:26 -0800
commitcb4e054e41cdb7e398351a5ae8224759e721349e (patch)
treeae2bec4f10425bd61e2a90563edc178d382bb4b8 /doc/lispref
parente6d575316a42946aac6d83c9587f09afd1a59d98 (diff)
parent60902756b0d794b16b9c1c67c4c40a3ac04d1c1b (diff)
downloademacs-cb4e054e41cdb7e398351a5ae8224759e721349e.tar.gz
emacs-cb4e054e41cdb7e398351a5ae8224759e721349e.zip
-
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/control.texi10
-rw-r--r--doc/lispref/display.texi2
-rw-r--r--doc/lispref/frames.texi6
-rw-r--r--doc/lispref/functions.texi6
-rw-r--r--doc/lispref/nonascii.texi6
-rw-r--r--doc/lispref/streams.texi6
-rw-r--r--doc/lispref/variables.texi39
-rw-r--r--doc/lispref/windows.texi18
8 files changed, 40 insertions, 53 deletions
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index df60347f839..6fa802d9fdd 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -302,8 +302,8 @@ predicate conditions that compare values of expressions against
302specific values known and written in advance. However, sometimes it 302specific values known and written in advance. However, sometimes it
303is useful to select alternatives based on more general conditions that 303is useful to select alternatives based on more general conditions that
304distinguish between broad classes of values. The @code{pcase} macro 304distinguish between broad classes of values. The @code{pcase} macro
305allows to choose between alternatives based on matching the value of 305allows you to choose between alternatives based on matching the value
306an expression against a series of patterns. A pattern can be a 306of an expression against a series of patterns. A pattern can be a
307literal value (comparison to literal values is what @code{cond} does), 307literal value (comparison to literal values is what @code{cond} does),
308or it can be a more general description of the expected structure of 308or it can be a more general description of the expected structure of
309the expression's value. 309the expression's value.
@@ -350,7 +350,7 @@ when called with the value being matched as its argument.
350@var{predfun} can be one of the possible forms described below. 350@var{predfun} can be one of the possible forms described below.
351@item (guard @var{boolean-expression}) 351@item (guard @var{boolean-expression})
352Matches if @var{boolean-expression} evaluates to non-@code{nil}. This 352Matches if @var{boolean-expression} evaluates to non-@code{nil}. This
353allows to include in a UPattern boolean conditions that refer to 353allows you to include in a UPattern boolean conditions that refer to
354symbols bound to values (including the value being matched) by 354symbols bound to values (including the value being matched) by
355previous UPatterns. Typically used inside an @code{and} UPattern, see 355previous UPatterns. Typically used inside an @code{and} UPattern, see
356below. For example, @w{@code{(and x (guard (< x 10)))}} is a pattern 356below. For example, @w{@code{(and x (guard (< x 10)))}} is a pattern
@@ -358,7 +358,7 @@ which matches any number smaller than 10 and let-binds the variable
358@code{x} to that number. 358@code{x} to that number.
359@item (let @var{upattern} @var{expression}) 359@item (let @var{upattern} @var{expression})
360Matches if the specified @var{expression} matches the specified 360Matches if the specified @var{expression} matches the specified
361@var{upattern}. This allows to match a pattern against the value of 361@var{upattern}. This allows matching a pattern against the value of
362an @emph{arbitrary} expression, not just the expression that is the 362an @emph{arbitrary} expression, not just the expression that is the
363first argument to @code{pcase}. (It is called @code{let} because 363first argument to @code{pcase}. (It is called @code{let} because
364@var{upattern} can bind symbols to values using the @var{symbol} 364@var{upattern} can bind symbols to values using the @var{symbol}
@@ -407,7 +407,7 @@ Here's an illustrative example of using UPatterns:
407 (code (message "Unknown return code %S" code))) 407 (code (message "Unknown return code %S" code)))
408@end example 408@end example
409 409
410The QPatterns are more powerful. They allow to match the value of the 410The QPatterns are more powerful. They allow matching the value of the
411@var{expression} that is the first argument of @code{pcase} against 411@var{expression} that is the first argument of @code{pcase} against
412specifications of its @emph{structure}. For example, you can specify 412specifications of its @emph{structure}. For example, you can specify
413that the value must be a list of 2 elements whose first element is a 413that the value must be a list of 2 elements whose first element is a
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index d77059916fc..eaba03d5739 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -4303,7 +4303,7 @@ divider ends above the bottom divider.
4303 Dividers can be dragged with the mouse and are therefore useful for 4303 Dividers can be dragged with the mouse and are therefore useful for
4304adjusting the sizes of adjacent windows with the mouse. They also serve 4304adjusting the sizes of adjacent windows with the mouse. They also serve
4305to visually set apart adjacent windows when no scroll bars or mode lines 4305to visually set apart adjacent windows when no scroll bars or mode lines
4306are present. The following three faces allow to customize the 4306are present. The following three faces allow the customization of the
4307appearance of dividers: 4307appearance of dividers:
4308 4308
4309@table @code 4309@table @code
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 614b7db0cac..55d72427548 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -2403,8 +2403,8 @@ The resulting mouse position is not constrained to the native frame of
2403The return value is not significant. 2403The return value is not significant.
2404@end defun 2404@end defun
2405 2405
2406On a graphical terminal the following two functions allow to retrieve 2406On a graphical terminal the following two functions allow the absolute
2407and set the absolute position of the mouse cursor. 2407position of the mouse cursor to be retrieved and set.
2408 2408
2409@defun mouse-absolute-pixel-position 2409@defun mouse-absolute-pixel-position
2410This function returns a cons cell (@var{x} . @var{y}) of the coordinates 2410This function returns a cons cell (@var{x} . @var{y}) of the coordinates
@@ -2426,7 +2426,7 @@ This predicate function returns non-@code{nil} if the mouse pointer
2426displayed on @var{frame} is visible; otherwise it returns @code{nil}. 2426displayed on @var{frame} is visible; otherwise it returns @code{nil}.
2427@var{frame} omitted or @code{nil} means the selected frame. This is 2427@var{frame} omitted or @code{nil} means the selected frame. This is
2428useful when @code{make-pointer-invisible} is set to @code{t}: it 2428useful when @code{make-pointer-invisible} is set to @code{t}: it
2429allows to know if the pointer has been hidden. 2429allows you to know if the pointer has been hidden.
2430@xref{Mouse Avoidance,,,emacs, The Emacs Manual}. 2430@xref{Mouse Avoidance,,,emacs, The Emacs Manual}.
2431@end defun 2431@end defun
2432 2432
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index c5f5b4c22c4..a2e94c34b62 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -1248,7 +1248,7 @@ Parent type: @code{array}.
1248@item font-object 1248@item font-object
1249@end table 1249@end table
1250 1250
1251The optional @var{qualifier} allows to combine several applicable 1251The optional @var{qualifier} allows combining several applicable
1252methods. If it is not present, the defined method is a @dfn{primary} 1252methods. If it is not present, the defined method is a @dfn{primary}
1253method, responsible for providing the primary implementation of the 1253method, responsible for providing the primary implementation of the
1254generic function for the specialized arguments. You can also define 1254generic function for the specialized arguments. You can also define
@@ -1270,8 +1270,8 @@ The most specific of such methods will be run before any other method.
1270Such methods normally use @code{cl-call-next-method}, described below, 1270Such methods normally use @code{cl-call-next-method}, described below,
1271to invoke the other auxiliary or primary methods. 1271to invoke the other auxiliary or primary methods.
1272@item :extra @var{string} 1272@item :extra @var{string}
1273This allows to add more methods, distinguished by @var{string}, for 1273This allows you to add more methods, distinguished by @var{string},
1274the same specializers and qualifiers. 1274for the same specializers and qualifiers.
1275@end table 1275@end table
1276@end defmac 1276@end defmac
1277 1277
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi
index fca40238805..9cf3b5750f2 100644
--- a/doc/lispref/nonascii.texi
+++ b/doc/lispref/nonascii.texi
@@ -1338,9 +1338,9 @@ operates on the contents of @var{string} instead of bytes in the buffer.
1338@cindex null bytes, and decoding text 1338@cindex null bytes, and decoding text
1339@defvar inhibit-null-byte-detection 1339@defvar inhibit-null-byte-detection
1340If this variable has a non-@code{nil} value, null bytes are ignored 1340If this variable has a non-@code{nil} value, null bytes are ignored
1341when detecting the encoding of a region or a string. This allows to 1341when detecting the encoding of a region or a string. This allows the
1342correctly detect the encoding of text that contains null bytes, such 1342encoding of text that contains null bytes to be correctly detected,
1343as Info files with Index nodes. 1343such as Info files with Index nodes.
1344@end defvar 1344@end defvar
1345 1345
1346@defvar inhibit-iso-escape-detection 1346@defvar inhibit-iso-escape-detection
diff --git a/doc/lispref/streams.texi b/doc/lispref/streams.texi
index 80c194b1bdd..41bc71e6aea 100644
--- a/doc/lispref/streams.texi
+++ b/doc/lispref/streams.texi
@@ -343,10 +343,10 @@ shared structures. @xref{Circular Objects}. Its default value is
343When reading or writing from the standard input/output streams of the 343When reading or writing from the standard input/output streams of the
344Emacs process in batch mode, it is sometimes required to make sure any 344Emacs process in batch mode, it is sometimes required to make sure any
345arbitrary binary data will be read/written verbatim, and/or that no 345arbitrary binary data will be read/written verbatim, and/or that no
346translation of newlines to or from CR-LF pairs are performed. This 346translation of newlines to or from CR-LF pairs is performed. This
347issue does not exist on Posix hosts, only on MS-Windows and MS-DOS@. 347issue does not exist on Posix hosts, only on MS-Windows and MS-DOS@.
348The following function allows to control the I/O mode of any standard 348The following function allows you to control the I/O mode of any
349stream of the Emacs process. 349standard stream of the Emacs process.
350 350
351@defun set-binary-mode stream mode 351@defun set-binary-mode stream mode
352Switch @var{stream} into binary or text I/O mode. If @var{mode} is 352Switch @var{stream} into binary or text I/O mode. If @var{mode} is
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 42701614365..6c53e9b6cca 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -1765,33 +1765,20 @@ variables: by putting them in a special file, or by defining a
1765@dfn{project class} for that directory. 1765@dfn{project class} for that directory.
1766 1766
1767@defvr Constant dir-locals-file 1767@defvr Constant dir-locals-file
1768This constant is a wildcard pattern matching the name of files where 1768This constant is the name of the file where Emacs expects to find the
1769Emacs expects to find directory-local variables. Its value is 1769directory-local variables. The name of the file is
1770@file{.dir-locals*.el}@footnote{ 1770@file{.dir-locals.el}@footnote{
1771The MS-DOS version of Emacs uses @file{_dir-locals*.el} instead, due to 1771The MS-DOS version of Emacs uses @file{_dir-locals.el} instead, due to
1772limitations of the DOS filesystems. 1772limitations of the DOS filesystems.
1773}, and the most common file name to use is @file{.dir-locals.el}. 1773}. A file by that name in a directory causes Emacs to apply its
1774 1774settings to any file in that directory or any of its subdirectories
1775Any file matching this name pattern in a directory causes Emacs to 1775(optionally, you can exclude subdirectories; see below).
1776apply its settings when visiting files in that directory or any of its 1776If some of the subdirectories have their own @file{.dir-locals.el}
1777subdirectories (optionally, you can exclude subdirectories; see 1777files, Emacs uses the settings from the deepest file it finds starting
1778below). 1778from the file's directory and moving up the directory tree. The file
1779If some of the subdirectories have their own file matching 1779specifies local variables as a specially formatted list; see
1780@file{.dir-locals*.el}, Emacs uses the settings from the deepest file 1780@ref{Directory Variables, , Per-directory Local Variables, emacs, The
1781it finds starting from the file's directory and moving up the 1781GNU Emacs Manual}, for more details.
1782directory tree. The file specifies local variables as a specially
1783formatted list; see @ref{Directory Variables, , Per-directory Local
1784Variables, emacs, The GNU Emacs Manual}, for more details.
1785
1786If the same directory contains multiple such files (for instance,
1787@file{.dir-locals.el} and @file{.dir-locals2.el}), then all of them
1788are used in @code{string<} order. This means that, if two files
1789specify different values for the same variable, the file sorted after
1790will override the value of the previous file (for instance, values in
1791@file{.dir-locals2.el} override those in @file{.dir-locals.el}). Note
1792that, because of how lexicographic order works, values in
1793@file{.dir-locals10.el} are overridden by values in @file{.dir-locals2.el}.
1794This can be avoided by using @file{.dir-locals02.el} instead.
1795@end defvr 1782@end defvr
1796 1783
1797@defun hack-dir-local-variables 1784@defun hack-dir-local-variables
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 7186791f94a..ca756e3ff7f 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -383,8 +383,8 @@ as if @var{mini} were @code{nil}.
383If it doesn't find a suitable window, this function returns @code{nil}. 383If it doesn't find a suitable window, this function returns @code{nil}.
384@end defun 384@end defun
385 385
386The following function allows to retrieve the entire window tree of a 386The following function allows the entire window tree of a frame to be
387frame: 387retrieved:
388 388
389@defun window-tree &optional frame 389@defun window-tree &optional frame
390This function returns a list representing the window tree for frame 390This function returns a list representing the window tree for frame
@@ -1476,7 +1476,7 @@ displaying a buffer only temporarily (@pxref{Temporary Displays}), and
1476you want to continue working with the initial layout. 1476you want to continue working with the initial layout.
1477 1477
1478The behavior can be fixed by making a new parent window when splitting 1478The behavior can be fixed by making a new parent window when splitting
1479@var{W2}. The variable described next allows to do that. 1479@var{W2}. The variable described next allows that to be done.
1480 1480
1481@defopt window-combination-limit 1481@defopt window-combination-limit
1482This variable controls whether splitting a window shall make a new 1482This variable controls whether splitting a window shall make a new
@@ -1579,7 +1579,7 @@ combination limit of @var{W4} (the parent window of @var{W6} and
1579 1579
1580Alternatively, the problems sketched above can be avoided by always 1580Alternatively, the problems sketched above can be avoided by always
1581resizing all windows in the same combination whenever one of its windows 1581resizing all windows in the same combination whenever one of its windows
1582is split or deleted. This also permits to split windows that would be 1582is split or deleted. This also permits splitting windows that would be
1583otherwise too small for such an operation. 1583otherwise too small for such an operation.
1584 1584
1585@defopt window-combination-resize 1585@defopt window-combination-resize
@@ -2522,11 +2522,11 @@ windows are dedicated to another buffer (@pxref{Dedicated Windows}).
2522 2522
2523@defun display-buffer-no-window buffer alist 2523@defun display-buffer-no-window buffer alist
2524If @var{alist} has a non-@code{nil} @code{allow-no-window} entry, then 2524If @var{alist} has a non-@code{nil} @code{allow-no-window} entry, then
2525this function does not display @code{buffer}. This allows to override 2525this function does not display @code{buffer}. This allows you to
2526the default action and avoid displaying the buffer. It is assumed that 2526override the default action and avoid displaying the buffer. It is
2527when the caller specifies a non-@code{nil} @code{allow-no-window} value 2527assumed that when the caller specifies a non-@code{nil}
2528it can handle a @code{nil} value returned from @code{display-buffer} in 2528@code{allow-no-window} value it can handle a @code{nil} value returned
2529this case. 2529from @code{display-buffer} in this case.
2530@end defun 2530@end defun
2531 2531
2532To illustrate the use of action functions, consider the following 2532To illustrate the use of action functions, consider the following