From: Gerd Moellmann <gerd@gnu.org>
Date: Mon, 20 Nov 2000 20:28:41 +0000 (+0000)
Subject: Add description of function window-list.
X-Git-Tag: emacs-pretest-21.0.92~258
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e258eedc76c7259036ac956a0a73f0b0caa2da63;p=emacs.git

Add description of function window-list.
---

diff --git a/lispref/windows.texi b/lispref/windows.texi
index 053edf2b661..0298407729a 100644
--- a/lispref/windows.texi
+++ b/lispref/windows.texi
@@ -581,6 +581,20 @@ set of windows to include in the scan.  See @code{next-window}, above,
 for details.
 @end defun
 
+@defun window-list &optional frame minibuf window
+This function returns a list of the windows on @var{frame}, starting
+with @var{window}.  If @var{frame} is @code{nil} or omitted, the
+selected frame is used instead; if @var{window} is @code{nil} or
+omitted, the selected window is used instead.
+
+The value of @var{minibuf} determines if the minibuffer window will be
+included in the result list.  If @var{minibuf} is @code{t}, the
+minibuffer window will be included, even if it isn't active.  If
+@var[minibuf} is @code{nil} or omitted, the minibuffer window will
+only be included in the list if it is active.  If @var{minibuf} is
+neither @code{nil} nor @code{t}, the minibuffer window is not
+included, whether or not it is active.
+
 @node Buffers and Windows
 @section Buffers and Windows
 @cindex examining windows