comparison lispref/windows.texi @ 71145:def7385eb131

(Splitting Windows): Clarify splitting nonselected window.
author Richard M. Stallman <rms@gnu.org>
date Fri, 02 Jun 2006 02:12:22 +0000
parents f7aff7b6d4af
children 8f15eeef57c8 a8190f7e546e
comparison
equal deleted inserted replaced
71144:2f86f394f7bc 71145:def7385eb131
159 The functions described here do not accept a buffer as an argument. 159 The functions described here do not accept a buffer as an argument.
160 The two ``halves'' of the split window initially display the same buffer 160 The two ``halves'' of the split window initially display the same buffer
161 previously visible in the window that was split. 161 previously visible in the window that was split.
162 162
163 @deffn Command split-window &optional window size horizontal 163 @deffn Command split-window &optional window size horizontal
164 This function splits @var{window} into two windows. The original 164 This function splits a new window out of @var{window}'s screen area.
165 window @var{window} remains the selected window, but occupies only 165 It returns the new window.
166 part of its former screen area. The rest is occupied by a newly created
167 window which is returned as the value of this function.
168 166
169 If @var{horizontal} is non-@code{nil}, then @var{window} splits into 167 If @var{horizontal} is non-@code{nil}, then @var{window} splits into
170 two side by side windows. The original window @var{window} keeps the 168 two side by side windows. The original window @var{window} keeps the
171 leftmost @var{size} columns, and gives the rest of the columns to the 169 leftmost @var{size} columns, and gives the rest of the columns to the
172 new window. Otherwise, it splits into windows one above the other, and 170 new window. Otherwise, it splits into windows one above the other, and
173 @var{window} keeps the upper @var{size} lines and gives the rest of the 171 @var{window} keeps the upper @var{size} lines and gives the rest of the
174 lines to the new window. The original window is therefore the 172 lines to the new window. The original window is therefore the
175 left-hand or upper of the two, and the new window is the right-hand or 173 left-hand or upper of the two, and the new window is the right-hand or
176 lower. 174 lower.
177 175
178 If @var{window} is omitted or @code{nil}, then the selected window is 176 If @var{window} is omitted or @code{nil}, that stands for the selected
179 split. If @var{size} is omitted or @code{nil}, then @var{window} is 177 window. When you split the selected window, it remains selected.
180 divided evenly into two parts. (If there is an odd line, it is 178
181 allocated to the new window.) When @code{split-window} is called 179 If @var{size} is omitted or @code{nil}, then @var{window} is divided
182 interactively, all its arguments are @code{nil}. 180 evenly into two parts. (If there is an odd line, it is allocated to
181 the new window.) When @code{split-window} is called interactively,
182 all its arguments are @code{nil}.
183 183
184 If splitting would result in making a window that is smaller than 184 If splitting would result in making a window that is smaller than
185 @code{window-min-height} or @code{window-min-width}, the function 185 @code{window-min-height} or @code{window-min-width}, the function
186 signals an error and does not split the window at all. 186 signals an error and does not split the window at all.
187 187