Make ediff handle remote and quoted file names
[emacs.git] / doc / emacs / buffers.texi
blobf3a3c8ef251e01c63a29458ee51a38011e5ec8d5
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2017 Free Software
3 @c Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node Buffers
6 @chapter Using Multiple Buffers
8 @cindex buffers
9   The text you are editing in Emacs resides in an object called a
10 @dfn{buffer}.  Each time you visit a file, a buffer is used to hold
11 the file's text.  Each time you invoke Dired, a buffer is used to hold
12 the directory listing.  If you send a message with @kbd{C-x m}, a
13 buffer is used to hold the text of the message.  When you ask for a
14 command's documentation, that appears in a buffer named @file{*Help*}.
16   Each buffer has a unique name, which can be of any length.  When a
17 buffer is displayed in a window, its name is shown in the mode line
18 (@pxref{Mode Line}).  The distinction between upper and lower case
19 matters in buffer names.  Most buffers are made by visiting files, and
20 their names are derived from the files' names; however, you can also
21 create an empty buffer with any name you want.  A newly started Emacs
22 has several buffers, including one named @file{*scratch*}, which can
23 be used for evaluating Lisp expressions and is not associated with any
24 file (@pxref{Lisp Interaction}).
26 @cindex selected buffer
27 @cindex current buffer
28   At any time, one and only one buffer is @dfn{selected}; we call it
29 the @dfn{current buffer}.  We sometimes say that a command operates on
30 ``the buffer''; this really means that it operates on the current
31 buffer.  When there is only one Emacs window, the buffer displayed in
32 that window is current.  When there are multiple windows, the buffer
33 displayed in the @dfn{selected window} is current.  @xref{Windows}.
35   Aside from its textual contents, each buffer records several pieces
36 of information, such as what file it is visiting (if any), whether it
37 is modified, and what major mode and minor modes are in effect
38 (@pxref{Modes}).  These are stored in @dfn{buffer-local
39 variables}---variables that can have a different value in each buffer.
40 @xref{Locals}.
42 @cindex buffer size, maximum
43   A buffer's size cannot be larger than some maximum, which is defined
44 by the largest buffer position representable by @dfn{Emacs integers}.
45 This is because Emacs tracks buffer positions using that data type.
46 For typical 64-bit machines, this maximum buffer size is @math{2^{61} - 2}
47 bytes, or about 2 EiB@.  For typical 32-bit machines, the maximum is
48 usually @math{2^{29} - 2} bytes, or about 512 MiB@.  Buffer sizes are
49 also limited by the amount of memory in the system.
51 @menu
52 * Select Buffer::       Creating a new buffer or reselecting an old one.
53 * List Buffers::        Getting a list of buffers that exist.
54 * Misc Buffer::         Renaming; changing read-only status; copying text.
55 * Kill Buffer::         Killing buffers you no longer need.
56 * Several Buffers::     How to go through the list of all buffers
57                           and operate variously on several of them.
58 * Indirect Buffers::    An indirect buffer shares the text of another buffer.
59 * Buffer Convenience::  Convenience and customization features for
60                           buffer handling.
61 @end menu
63 @node Select Buffer
64 @section Creating and Selecting Buffers
65 @cindex change buffers
66 @cindex switch buffers
68 @table @kbd
69 @item C-x b @var{buffer} @key{RET}
70 Select or create a buffer named @var{buffer} (@code{switch-to-buffer}).
71 @item C-x 4 b @var{buffer} @key{RET}
72 Similar, but select @var{buffer} in another window
73 (@code{switch-to-buffer-other-window}).
74 @item C-x 5 b @var{buffer} @key{RET}
75 Similar, but select @var{buffer} in a separate frame
76 (@code{switch-to-buffer-other-frame}).
77 @item C-x @key{LEFT}
78 Select the previous buffer in the buffer list (@code{previous-buffer}).
79 @item C-x @key{RIGHT}
80 Select the next buffer in the buffer list (@code{next-buffer}).
81 @item C-u M-g M-g
82 @itemx C-u M-g g
83 Read a number @var{n} and move to line @var{n} in the most recently
84 selected buffer other than the current buffer.
85 @end table
87 @kindex C-x b
88 @findex switch-to-buffer
89   The @kbd{C-x b} (@code{switch-to-buffer}) command reads a buffer
90 name using the minibuffer.  Then it makes that buffer current, and
91 displays it in the currently-selected window.  An empty input
92 specifies the buffer that was current most recently among those not
93 now displayed in any window.
95   While entering the buffer name, you can use the usual completion and
96 history commands (@pxref{Minibuffer}).  Note that @kbd{C-x b}, and
97 related commands, use @dfn{permissive completion with confirmation} for
98 minibuffer completion: if you type @key{RET} immediately after
99 completing up to a nonexistent buffer name, Emacs prints
100 @samp{[Confirm]} and you must type a second @key{RET} to submit that
101 buffer name.  @xref{Completion Exit}, for details.
103   If you specify a buffer that does not exist, @kbd{C-x b} creates a
104 new, empty buffer that is not visiting any file, and selects it for
105 editing.  The default value of the variable @code{major-mode}
106 determines the new buffer's major mode; the default value is
107 Fundamental mode.  @xref{Major Modes}.  One reason to create a new
108 buffer is to use it for making temporary notes.  If you try to save
109 it, Emacs asks for the file name to use, and the buffer's major mode
110 is re-established taking that file name into account (@pxref{Choosing
111 Modes}).
113 @kindex C-x @key{LEFT}
114 @kindex C-x @key{RIGHT}
115 @findex next-buffer
116 @findex previous-buffer
117   For conveniently switching between a few buffers, use the commands
118 @kbd{C-x @key{LEFT}} and @kbd{C-x @key{RIGHT}}.  @kbd{C-x @key{LEFT}}
119 (@code{previous-buffer}) selects the previous buffer (following the
120 order of most recent selection in the current frame), while @kbd{C-x
121 @key{RIGHT}} (@code{next-buffer}) moves through buffers in the reverse
122 direction.
124 @kindex C-x 4 b
125 @findex switch-to-buffer-other-window
126   To select a buffer in a window other than the current one, type
127 @kbd{C-x 4 b} (@code{switch-to-buffer-other-window}).  This prompts
128 for a buffer name using the minibuffer, displays that buffer in
129 another window, and selects that window.
131 @kindex C-x 5 b
132 @findex switch-to-buffer-other-frame
133   Similarly, @kbd{C-x 5 b} (@code{switch-to-buffer-other-frame})
134 prompts for a buffer name, displays that buffer in another frame, and
135 selects that frame.  If the buffer is already being shown in a window
136 on another frame, Emacs selects that window and frame instead of
137 creating a new frame.
139   @xref{Displaying Buffers}, for how the @kbd{C-x 4 b} and @kbd{C-x 5
140 b} commands get the window and/or frame to display in.
142   In addition, @kbd{C-x C-f}, and any other command for visiting a
143 file, can also be used to switch to an existing file-visiting buffer.
144 @xref{Visiting}.
146 @findex goto-line
147   @kbd{C-u M-g M-g}, that is @code{goto-line} with a plain prefix
148 argument, reads a number @var{n} using the minibuffer, selects the
149 most recently selected buffer other than the current buffer in another
150 window, and then moves point to the beginning of line number @var{n}
151 in that buffer.  This is mainly useful in a buffer that refers to line
152 numbers in another buffer: if point is on or just after a number,
153 @code{goto-line} uses that number as the default for @var{n}.  Note
154 that prefix arguments other than just @kbd{C-u} behave differently.
155 @kbd{C-u 4 M-g M-g} goes to line 4 in the @emph{current} buffer,
156 without reading a number from the minibuffer.  (Remember that @kbd{M-g
157 M-g} without prefix argument reads a number @var{n} and then moves to
158 line number @var{n} in the current buffer.  @xref{Moving Point}.)
160   Emacs uses buffer names that start with a space for internal purposes.
161 It treats these buffers specially in minor ways---for example, by
162 default they do not record undo information.  It is best to avoid using
163 such buffer names yourself.
165 @node List Buffers
166 @section Listing Existing Buffers
168 @table @kbd
169 @item C-x C-b
170 List the existing buffers (@code{list-buffers}).
171 @end table
173 @cindex listing current buffers
174 @kindex C-x C-b
175 @findex list-buffers
176   To display a list of existing buffers, type @kbd{C-x C-b}.  Each
177 line in the list shows one buffer's name, size, major mode and visited file.
178 The buffers are listed in the order that they were current; the
179 buffers that were current most recently come first.
181   @samp{.} in the first field of a line indicates that the buffer is
182 current.  @samp{%} indicates a read-only buffer.  @samp{*} indicates
183 that the buffer is modified.  If several buffers are modified, it
184 may be time to save some with @kbd{C-x s} (@pxref{Save Commands}).
185 Here is an example of a buffer list:
187 @smallexample
188 CRM Buffer                Size  Mode              File
189 . * .emacs                3294  Emacs-Lisp        ~/.emacs
190  %  *Help*                 101  Help
191     search.c             86055  C                 ~/cvs/emacs/src/search.c
192  %  src                  20959  Dired by name     ~/cvs/emacs/src/
193   * *mail*                  42  Mail
194  %  HELLO                 1607  Fundamental       ~/cvs/emacs/etc/HELLO
195  %  NEWS                481184  Outline           ~/cvs/emacs/etc/NEWS
196     *scratch*              191  Lisp Interaction
197   * *Messages*            1554  Messages
198 @end smallexample
200 @noindent
201 The buffer @file{*Help*} was made by a help request (@pxref{Help}); it
202 is not visiting any file.  The buffer @code{src} was made by Dired on
203 the directory @file{~/cvs/emacs/src/}.  You can list only buffers that
204 are visiting files by giving the command a prefix argument, as in
205 @kbd{C-u C-x C-b}.
207   @code{list-buffers} omits buffers whose names begin with a space,
208 unless they visit files: such buffers are used internally by Emacs.
210 @node Misc Buffer
211 @section Miscellaneous Buffer Operations
213 @table @kbd
214 @item C-x C-q
215 Toggle read-only status of buffer (@code{read-only-mode}).
216 @item M-x rename-buffer @key{RET} @var{name} @key{RET}
217 Change the name of the current buffer.
218 @item M-x rename-uniquely
219 Rename the current buffer by adding @samp{<@var{number}>} to the end.
220 @item M-x view-buffer @key{RET} @var{buffer} @key{RET}
221 Scroll through buffer @var{buffer}.  @xref{View Mode}.
222 @end table
224 @kindex C-x C-q
225 @vindex buffer-read-only
226 @cindex read-only buffer
227   A buffer can be @dfn{read-only}, which means that commands to change
228 its contents are not allowed.  The mode line indicates read-only
229 buffers with @samp{%%} or @samp{%*} near the left margin.  @xref{Mode
230 Line}.  Read-only buffers are usually made by subsystems such as Dired
231 and Rmail that have special commands to operate on the text; also by
232 visiting a file whose access control says you cannot write it.
234 @findex read-only-mode
235 @vindex view-read-only
236  The command @kbd{C-x C-q} (@code{read-only-mode}) makes a read-only
237 buffer writable, and makes a writable buffer read-only.  This works by
238 setting the variable @code{buffer-read-only}, which has a local value
239 in each buffer and makes the buffer read-only if its value is
240 non-@code{nil}.  If you change the option @code{view-read-only} to a
241 non-@code{nil} value, making the buffer read-only with @kbd{C-x C-q}
242 also enables View mode in the buffer (@pxref{View Mode}).
244 @findex rename-buffer
245   @kbd{M-x rename-buffer} changes the name of the current buffer.  You
246 specify the new name as a minibuffer argument; there is no default.
247 If you specify a name that is in use for some other buffer, an error
248 happens and no renaming is done.
250 @findex rename-uniquely
251   @kbd{M-x rename-uniquely} renames the current buffer to a similar
252 name with a numeric suffix added to make it both different and unique.
253 This command does not need an argument.  It is useful for creating
254 multiple shell buffers: if you rename the @file{*shell*} buffer, then
255 do @kbd{M-x shell} again, it makes a new shell buffer named
256 @file{*shell*}; meanwhile, the old shell buffer continues to exist
257 under its new name.  This method is also good for mail buffers,
258 compilation buffers, and most Emacs features that create special
259 buffers with particular names.  (With some of these features, such as
260 @kbd{M-x compile}, @kbd{M-x grep}, you need to switch to some other
261 buffer before using the command again, otherwise it will reuse the
262 current buffer despite the name change.)
264   The commands @kbd{M-x append-to-buffer} and @kbd{M-x insert-buffer}
265 can also be used to copy text from one buffer to another.
266 @xref{Accumulating Text}.
268 @node Kill Buffer
269 @section Killing Buffers
271 @cindex killing buffers
272 @cindex close buffer
273 @cindex close file
274   If you continue an Emacs session for a while, you may accumulate a
275 large number of buffers.  You may then find it convenient to @dfn{kill}
276 the buffers you no longer need.  (Some other editors call this
277 operation @dfn{close}, and talk about ``closing the buffer'' or
278 ``closing the file'' visited in the buffer.)  On most operating
279 systems, killing a buffer releases its space back to the operating
280 system so that other programs can use it.  Here are some commands for
281 killing buffers:
283 @table @kbd
284 @item C-x k @var{bufname} @key{RET}
285 Kill buffer @var{bufname} (@code{kill-buffer}).
286 @item M-x kill-some-buffers
287 Offer to kill each buffer, one by one.
288 @item M-x kill-matching-buffers
289 Offer to kill all buffers matching a regular expression.
290 @end table
292 @findex kill-buffer
293 @kindex C-x k
294   @kbd{C-x k} (@code{kill-buffer}) kills one buffer, whose name you
295 specify in the minibuffer.  The default, used if you type just
296 @key{RET} in the minibuffer, is to kill the current buffer.  If you
297 kill the current buffer, another buffer becomes current: one that was
298 current in the recent past but is not displayed in any window now.  If
299 you ask to kill a file-visiting buffer that is modified, then you must
300 confirm with @kbd{yes} before the buffer is killed.
302 @findex kill-some-buffers
303   The command @kbd{M-x kill-some-buffers} asks about each buffer, one
304 by one.  An answer of @kbd{y} means to kill the buffer, just like
305 @code{kill-buffer}.  This command ignores buffers whose names begin
306 with a space, which are used internally by Emacs.
308 @findex kill-matching-buffers
309   The command @kbd{M-x kill-matching-buffers} prompts for a regular
310 expression and kills all buffers whose names match that expression.
311 @xref{Regexps}.  Like @code{kill-some-buffers}, it asks for
312 confirmation before each kill.  This command normally ignores buffers
313 whose names begin with a space, which are used internally by Emacs.
314 To kill internal buffers as well, call @code{kill-matching-buffers}
315 with a prefix argument.
317   The Buffer Menu feature is also convenient for killing various
318 buffers.  @xref{Several Buffers}.
320 @vindex kill-buffer-hook
321   If you want to do something special every time a buffer is killed, you
322 can add hook functions to the hook @code{kill-buffer-hook} (@pxref{Hooks}).
324 @findex clean-buffer-list
325   If you run one Emacs session for a period of days, as many people do,
326 it can fill up with buffers that you used several days ago.  The command
327 @kbd{M-x clean-buffer-list} is a convenient way to purge them; it kills
328 all the unmodified buffers that you have not used for a long time.  An
329 ordinary buffer is killed if it has not been displayed for three days;
330 however, you can specify certain buffers that should never be killed
331 automatically, and others that should be killed if they have been unused
332 for a mere hour.
334 @cindex Midnight mode
335 @vindex midnight-mode
336 @vindex midnight-hook
337   You can also have this buffer purging done for you, once a day,
338 by enabling Midnight mode.  Midnight mode operates each day
339 at midnight; at that time, it runs @code{clean-buffer-list}, or
340 whichever functions you have placed in the normal hook
341 @code{midnight-hook} (@pxref{Hooks}).  To enable Midnight mode, use
342 the Customization buffer to set the variable @code{midnight-mode} to
343 @code{t}.  @xref{Easy Customization}.
345 @node Several Buffers
346 @section Operating on Several Buffers
347 @cindex Buffer Menu
349 @table @kbd
350 @item M-x buffer-menu
351 Begin editing a buffer listing all Emacs buffers.
352 @item M-x buffer-menu-other-window
353 Similar, but do it in another window.
354 @end table
356   The @dfn{Buffer Menu} opened by @kbd{C-x C-b} (@pxref{List Buffers})
357 does not merely list buffers.  It also allows you to perform various
358 operations on buffers, through an interface similar to Dired
359 (@pxref{Dired}).  You can save buffers, kill them (here called
360 @dfn{deleting} them, for consistency with Dired), or display them.
362 @findex buffer-menu
363 @findex buffer-menu-other-window
364   To use the Buffer Menu, type @kbd{C-x C-b} and switch to the window
365 displaying the @file{*Buffer List*} buffer.  You can also type
366 @kbd{M-x buffer-menu} to open the Buffer Menu in the selected window.
367 Alternatively, the command @kbd{M-x buffer-menu-other-window} opens
368 the Buffer Menu in another window, and selects that window.
370   The Buffer Menu is a read-only buffer, and can be changed only
371 through the special commands described in this section.  The usual
372 cursor motion commands can be used in this buffer.  The following
373 commands apply to the buffer described on the current line:
375 @table @kbd
376 @item d
377 @findex Buffer-menu-delete
378 @kindex d @r{(Buffer Menu)}
379 Flag the buffer for deletion (killing), then move point to the next
380 line (@code{Buffer-menu-delete}).  The deletion flag is indicated by
381 the character @samp{D} on the line, before the buffer name.  The
382 deletion occurs only when you type the @kbd{x} command (see below).
384 @item C-d
385 @findex Buffer-menu-delete-backwards
386 @kindex C-d @r{(Buffer Menu)}
387 Like @kbd{d}, but move point up instead of down
388 (@code{Buffer-menu-delete-backwards}).
390 @item s
391 @findex Buffer-menu-save
392 @kindex s @r{(Buffer Menu)}
393 Flag the buffer for saving (@code{Buffer-menu-save}).  The save flag
394 is indicated by the character @samp{S} on the line, before the buffer
395 name.  The saving occurs only when you type @kbd{x}.  You may request
396 both saving and deletion for the same buffer.
398 @item x
399 @findex Buffer-menu-execute
400 @kindex x @r{(Buffer Menu)}
401 Perform all flagged deletions and saves (@code{Buffer-menu-execute}).
403 @item u
404 @findex Buffer-menu-unmark
405 @kindex u @r{(Buffer Menu)}
406 Remove all flags from the current line, and move down
407 (@code{Buffer-menu-unmark}).
409 @item @key{DEL}
410 @findex Buffer-menu-backup-unmark
411 @kindex DEL @r{(Buffer Menu)}
412 Move to the previous line and remove all flags on that line
413 (@code{Buffer-menu-backup-unmark}).
415 @item M-@key{DEL}
416 @findex Buffer-menu-unmark-all-buffers
417 @kindex M-DEL @r{(Buffer Menu)}
418 Remove a particular flag from all lines
419 (@code{Buffer-menu-unmark-all-buffers}).
421 @item U
422 @findex Buffer-menu-unmark-all
423 @kindex U @r{(Buffer Menu)}
424 Remove all flags from all the lines
425 (@code{Buffer-menu-unmark-all}).
426 @end table
428 @noindent
429 The commands for adding or removing flags, @kbd{d}, @kbd{C-d}, @kbd{s}
430 and @kbd{u}, all accept a numeric argument as a repeat count.
432   The following commands operate immediately on the buffer listed on
433 the current line.  They also accept a numeric argument as a repeat
434 count.
436 @table @kbd
437 @item ~
438 @findex Buffer-menu-not-modified
439 @kindex ~ @r{(Buffer Menu)}
440 Mark the buffer as unmodified (@code{Buffer-menu-not-modified}).
441 @xref{Save Commands}.
443 @item %
444 @findex Buffer-menu-toggle-read-only
445 @kindex % @r{(Buffer Menu)}
446 Toggle the buffer's read-only status
447 (@code{Buffer-menu-toggle-read-only}).  @xref{Misc Buffer}.
449 @item t
450 @findex Buffer-menu-visit-tags-table
451 @kindex % @r{(Buffer Menu)}
452 Visit the buffer as a tags table
453 (@code{Buffer-menu-visit-tags-table}).  @xref{Select Tags Table}.
454 @end table
456   The following commands are used to select another buffer or buffers:
458 @table @kbd
459 @item q
460 @findex quit-window
461 @kindex q @r{(Buffer Menu)}
462 Quit the Buffer Menu (@code{quit-window}).  The most recent formerly
463 visible buffer is displayed in its place.
465 @item @key{RET}
466 @itemx f
467 @findex Buffer-menu-this-window
468 @kindex f @r{(Buffer Menu)}
469 @kindex RET @r{(Buffer Menu)}
470 Select this line's buffer, replacing the @file{*Buffer List*} buffer
471 in its window (@code{Buffer-menu-this-window}).
473 @item o
474 @findex Buffer-menu-other-window
475 @kindex o @r{(Buffer Menu)}
476 Select this line's buffer in another window, as if by @kbd{C-x 4 b},
477 leaving @file{*Buffer List*} visible
478 (@code{Buffer-menu-other-window}).
480 @item C-o
481 @findex Buffer-menu-switch-other-window
482 @kindex C-o @r{(Buffer Menu)}
483 Display this line's buffer in another window, without selecting it
484 (@code{Buffer-menu-switch-other-window}).
486 @item 1
487 @findex Buffer-menu-1-window
488 @kindex 1 @r{(Buffer Menu)}
489 Select this line's buffer in a full-frame window
490 (@code{Buffer-menu-1-window}).
492 @item 2
493 @findex Buffer-menu-2-window
494 @kindex 2 @r{(Buffer Menu)}
495 Set up two windows on the current frame, with this line's buffer
496 selected in one, and a previously current buffer (aside from
497 @file{*Buffer List*}) in the other (@code{Buffer-menu-2-window}).
499 @item b
500 @findex Buffer-menu-bury
501 @kindex b @r{(Buffer Menu)}
502 Bury this line's buffer (@code{Buffer-menu-bury}).
504 @item m
505 @findex Buffer-menu-mark
506 @kindex m @r{(Buffer Menu)}
507 Mark this line's buffer to be displayed in another window if you exit
508 with the @kbd{v} command (@code{Buffer-menu-mark}).  The display flag
509 is indicated by the character @samp{>} at the beginning of the line.
510 (A single buffer may not have both deletion and display flags.)
512 @item v
513 @findex Buffer-menu-select
514 @kindex v @r{(Buffer Menu)}
515 Select this line's buffer, and also display in other windows any
516 buffers flagged with the @kbd{m} command (@code{Buffer-menu-select}).
517 If you have not flagged any buffers, this command is equivalent to
518 @kbd{1}.
519 @end table
521   The following commands affect the entire buffer list:
523 @table @kbd
524 @item S
525 @findex tabulated-list-sort
526 @kindex S @r{(Buffer Menu)}
527 Sort the Buffer Menu entries according to their values in the column
528 at point.  With a numeric prefix argument @var{n}, sort according to
529 the @var{n}-th column (@code{tabulated-list-sort}).
531 @item T
532 @findex Buffer-menu-toggle-files-only
533 @kindex T @r{(Buffer Menu)}
534 Delete, or reinsert, lines for non-file buffers
535 (@code{Buffer-menu-toggle-files-only}).  This command toggles the
536 inclusion of such buffers in the buffer list.
537 @end table
539   Normally, the buffer @file{*Buffer List*} is not updated
540 automatically when buffers are created and killed; its contents are
541 just text.  If you have created, deleted or renamed buffers, the way
542 to update @file{*Buffer List*} to show what you have done is to type
543 @kbd{g} (@code{revert-buffer}).  You can make this happen regularly
544 every @code{auto-revert-interval} seconds if you enable Auto Revert
545 mode in this buffer, as long as it is not marked modified.  Global
546 Auto Revert mode applies to the @file{*Buffer List*} buffer only if
547 @code{global-auto-revert-non-file-buffers} is non-@code{nil}.
548 @iftex
549 @inforef{Autorevert,, emacs-xtra}, for details.
550 @end iftex
551 @ifnottex
552 @xref{Autorevert, global-auto-revert-non-file-buffers}, for details.
553 @end ifnottex
555 @node Indirect Buffers
556 @section Indirect Buffers
557 @cindex indirect buffer
558 @cindex base buffer
560   An @dfn{indirect buffer} shares the text of some other buffer, which
561 is called the @dfn{base buffer} of the indirect buffer.  In some ways it
562 is a buffer analogue of a symbolic link between files.
564 @table @kbd
565 @findex make-indirect-buffer
566 @item M-x make-indirect-buffer @key{RET} @var{base-buffer} @key{RET} @var{indirect-name} @key{RET}
567 Create an indirect buffer named @var{indirect-name} with base buffer
568 @var{base-buffer}.
569 @findex clone-indirect-buffer
570 @item M-x clone-indirect-buffer @key{RET}
571 Create an indirect buffer that is a twin copy of the current buffer.
572 @item C-x 4 c
573 @kindex C-x 4 c
574 @findex clone-indirect-buffer-other-window
575 Create an indirect buffer that is a twin copy of the current buffer, and
576 select it in another window (@code{clone-indirect-buffer-other-window}).
577 @end table
579   The text of the indirect buffer is always identical to the text of its
580 base buffer; changes made by editing either one are visible immediately
581 in the other.  But in all other respects, the indirect buffer and its
582 base buffer are completely separate.  They can have different names,
583 different values of point, different narrowing, different markers,
584 different major modes, and different local variables.
586   An indirect buffer cannot visit a file, but its base buffer can.  If
587 you try to save the indirect buffer, that actually works by saving the
588 base buffer.  Killing the base buffer effectively kills the indirect
589 buffer, but killing an indirect buffer has no effect on its base buffer.
591   One way to use indirect buffers is to display multiple views of an
592 outline.  @xref{Outline Views}.
594 @vindex clone-indirect-buffer-hook
595   A quick and handy way to make an indirect buffer is with the command
596 @kbd{M-x clone-indirect-buffer}.  It creates and selects an indirect
597 buffer whose base buffer is the current buffer.  With a numeric
598 argument, it prompts for the name of the indirect buffer; otherwise it
599 uses the name of the current buffer, with a @samp{<@var{n}>} suffix
600 added.  @kbd{C-x 4 c} (@code{clone-indirect-buffer-other-window})
601 works like @kbd{M-x clone-indirect-buffer}, but it selects the new
602 buffer in another window.  These functions run the hook
603 @code{clone-indirect-buffer-hook} after creating the indirect buffer.
605   The more general way to make an indirect buffer is with the command
606 @kbd{M-x make-indirect-buffer}.  It creates an indirect buffer
607 named @var{indirect-name} from a buffer @var{base-buffer}, prompting for
608 both using the minibuffer.
610 @node Buffer Convenience
611 @section Convenience Features and Customization of Buffer Handling
613    This section describes several modes and features that make it more
614 convenient to switch between buffers.
616 @menu
617 * Uniquify::               Making buffer names unique with directory parts.
618 * Icomplete::              Fast minibuffer selection.
619 * Buffer Menus::           Configurable buffer menu.
620 @end menu
622 @node Uniquify
623 @subsection Making Buffer Names Unique
625 @cindex unique buffer names
626 @cindex directories in buffer names
627   When several buffers visit identically-named files, Emacs must give
628 the buffers distinct names.  The default method adds a suffix based on
629 the names of the directories that contain the files.  For example, if
630 you visit files @file{/foo/bar/mumble/name} and
631 @file{/baz/quux/mumble/name} at the same time, their buffers will be
632 named @samp{name<bar/mumble>} and @samp{name<quux/mumble>}, respectively.
633 Emacs adds as many directory parts as are needed to make a unique name.
635 @vindex uniquify-buffer-name-style
636   You can choose from several different styles for constructing unique
637 buffer names, by customizing the option @code{uniquify-buffer-name-style}.
639   The @code{forward} naming method includes part of the file's
640 directory name at the beginning of the buffer name; using this method,
641 buffers visiting the files @file{/u/rms/tmp/Makefile} and
642 @file{/usr/projects/zaphod/Makefile} would be named
643 @samp{tmp/Makefile} and @samp{zaphod/Makefile}.
645   In contrast, the @code{post-forward} naming method would call the
646 buffers @samp{Makefile|tmp} and @samp{Makefile|zaphod}.  The default
647 method @code{post-forward-angle-brackets} is like @code{post-forward},
648 except that it encloses the unique path in angle brackets.  The
649 @code{reverse} naming method would call them @samp{Makefile\tmp} and
650 @samp{Makefile\zaphod}.  The nontrivial difference between
651 @code{post-forward} and @code{reverse} occurs when just one directory
652 name is not enough to distinguish two files; then @code{reverse} puts
653 the directory names in reverse order, so that @file{/top/middle/file}
654 becomes @samp{file\middle\top}, while @code{post-forward} puts them in
655 forward order after the file name, as in @samp{file|top/middle}.  If
656 @code{uniquify-buffer-name-style} is set to @code{nil}, the buffer
657 names simply get @samp{<2>}, @samp{<3>}, etc.@: appended.
659   Which rule to follow for putting the directory names in the buffer
660 name is not very important if you are going to @emph{look} at the
661 buffer names before you type one.  But as an experienced user, if you
662 know the rule, you won't have to look.  And then you may find that one
663 rule or another is easier for you to remember and apply quickly.
665 @node Icomplete
666 @subsection Fast minibuffer selection
668 @findex icomplete-mode
669 @cindex Icomplete mode
671   Icomplete global minor mode provides a convenient way to quickly select an
672 element among the possible completions in a minibuffer.  When enabled, typing
673 in the minibuffer continuously displays a list of possible completions that
674 match the string you have typed.
676   At any time, you can type @kbd{C-j} to select the first completion in
677 the list.  So the way to select a particular completion is to make it the
678 first in the list.  There are two ways to do this.  You can type more
679 of the completion name and thus narrow down the list, excluding unwanted
680 completions above the desired one.  Alternatively, you can use @kbd{C-.}
681 and @kbd{C-,} to rotate the list until the desired buffer is first.
683   @kbd{M-@key{TAB}} will select the first completion in the list, like
684 @kbd{C-j} but without exiting the minibuffer, so you can edit it
685 further.  This is typically used when entering a file name, where
686 @kbd{M-@key{TAB}} can be used a few times to descend in the hierarchy
687 of directories.
689   To enable Icomplete mode, type @kbd{M-x icomplete-mode}, or customize
690 the variable @code{icomplete-mode} to @code{t} (@pxref{Easy
691 Customization}).
693 @node Buffer Menus
694 @subsection Customizing Buffer Menus
696 @findex bs-show
697 @cindex buffer list, customizable
698 @table @kbd
699 @item M-x bs-show
700 Make a list of buffers similarly to @kbd{M-x list-buffers} but
701 customizable.
702 @end table
704   @kbd{M-x bs-show} pops up a buffer list similar to the one normally
705 displayed by @kbd{C-x C-b} but which you can customize.  If you prefer
706 this to the usual buffer list, you can bind this command to @kbd{C-x
707 C-b}.  To customize this buffer list, use the @code{bs} Custom group
708 (@pxref{Easy Customization}).
710 @findex msb-mode
711 @cindex mode, MSB
712 @cindex MSB mode
713 @findex mouse-buffer-menu
714 @kindex C-Down-mouse-1
715   MSB global minor mode (``MSB'' stands for ``mouse select buffer'')
716 provides a different and customizable mouse buffer menu which you may
717 prefer.  It replaces the bindings of @code{mouse-buffer-menu},
718 normally on @kbd{C-Down-mouse-1} and @kbd{C-@key{F10}}, and the menu
719 bar buffer menu.  You can customize the menu in the @code{msb} Custom
720 group.