From: Martin Rudalics <rudalics@gmx.at>
Date: Thu, 2 Jul 2015 09:19:25 +0000 (+0200)
Subject: Document new `window-divider-mode'.
X-Git-Tag: emacs-25.0.90~1580
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=29f8228b5b549bcc3638617c24c79634ad6959c4;p=emacs.git

Document new `window-divider-mode'.

* lisp/frame.el (window-divider-mode): Fix doc-string.
* doc/emacs/frames.texi (Window Dividers): New section.
---

diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index ad860fd62ca..8d24fc5806a 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -54,6 +54,7 @@ for doing so on MS-DOS).  Menus are supported on all text terminals.
 * Multiple Displays::   How one Emacs instance can talk to several displays.
 * Frame Parameters::    Changing the colors and other modes of frames.
 * Scroll Bars::         How to enable and disable scroll bars; how to use them.
+* Window Dividers::     Window separators that can be dragged with the mouse.
 * Drag and Drop::       Using drag and drop to open files and insert text.
 * Menu Bars::           Enabling and disabling the menu bar.
 * Tool Bars::           Enabling and disabling the tool bar.
@@ -1001,6 +1002,32 @@ or disable horizontal scroll bars (@pxref{Resources}).  To control the
 scroll bar height, change the @code{scroll-bar-height} frame parameter
 (@pxref{Frame Parameters,,, elisp, The Emacs Lisp Reference Manual}).
 
+@node Window Dividers
+@section Window Dividers
+@cindex Window Divider mode
+@cindex mode, Window Divider
+
+  On graphical displays, you can use @dfn{window dividers} in order to
+separate windows visually.  Window dividers are bars that can be dragged
+with the mouse, thus allowing to easily resize adjacent windows.
+
+@vindex window-divider-mode
+  To control the display of window dividers, customize the variable
+@code{window-divider-mode}.  Its value should be either
+@code{bottom-only} (to show dividers only on the bottom of windows),
+@code{right-only} (to show dividers only on the right of windows),
+@code{t} (to show them on the bottom and on the right) or @code{nil} (to
+disable window dividers).
+
+@vindex window-divider-default-bottom-width
+@vindex window-divider-default-right-width
+  To adjust the width of window dividers displayed by this mode
+customize the options @code{window-divider-default-bottom-width} and
+@code{window-divider-default-right-width}.
+
+   For more details about window dividers see @ref{Window Dividers,,
+Window Dividers, elisp, The Emacs Lisp Reference Manual}.
+
 @node Drag and Drop
 @section Drag and Drop
 @cindex drag and drop
diff --git a/etc/NEWS b/etc/NEWS
index 38a872dbe7a..7717fd02433 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1089,6 +1089,11 @@ fullwidth frames, the behavior may depend on the toolkit used.
 windows without "fixing" it.  It's supported by `fit-window-to-buffer',
 `temp-buffer-resize-mode' and `display-buffer'.
 
++++
+** New minor mode `window-divider-mode' and options
+`window-divider-default-bottom-width' and
+`window-divider-default-right-width'.
+
 +++
 ** New option `switch-to-buffer-in-dedicated-window' allows to customize
 how `switch-to-buffer' proceeds interactively when the selected window
diff --git a/lisp/frame.el b/lisp/frame.el
index ffa01b4dcc1..cd6823aadf2 100644
--- a/lisp/frame.el
+++ b/lisp/frame.el
@@ -1784,8 +1784,9 @@ With a prefix argument ARG, enable Window Divider mode if ARG is
 positive, and disable it otherwise.  If called from Lisp, enable
 the mode if ARG is omitted or nil.
 
-The option `window-divider-default-width' allows to customize the
-width of dividers displayed by this mode."
+The options `window-divider-default-bottom-width' and
+`window-divider-default-right-width' allow to customize the width
+of dividers displayed by this mode."
   :group 'window-divider
   :global t
   :variable (window-divider-mode