diff options
| author | Chong Yidong | 2012-11-07 14:54:43 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-11-07 14:54:43 +0800 |
| commit | cce0aa5aac8ae6a7fbcf1e586ab5db1cb836e26a (patch) | |
| tree | 1baea354c5e40e8c0c14ec27e10fc3a0349b9ec2 /doc | |
| parent | 7c08f8ba7246ddd20f70e8306f646ac981a64f5a (diff) | |
| download | emacs-cce0aa5aac8ae6a7fbcf1e586ab5db1cb836e26a.tar.gz emacs-cce0aa5aac8ae6a7fbcf1e586ab5db1cb836e26a.zip | |
Doc improvements for Buffer Menu.
* buffers.texi (Several Buffers): List Buffer Menu command anmes,
and index the keybindings. Document tabulated-list-sort.
(Kill Buffer): Capitalize Buffer Menu.
* trouble.texi (Memory Full): Capitalize Buffer Menu.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/emacs/buffers.texi | 186 | ||||
| -rw-r--r-- | doc/emacs/trouble.texi | 2 |
3 files changed, 133 insertions, 63 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 3413e93a3e8..489da459838 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2012-11-07 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * buffers.texi (Several Buffers): List Buffer Menu command anmes, | ||
| 4 | and index the keybindings. Document tabulated-list-sort. | ||
| 5 | (Kill Buffer): Capitalize Buffer Menu. | ||
| 6 | |||
| 7 | * trouble.texi (Memory Full): Capitalize Buffer Menu. | ||
| 8 | |||
| 1 | 2012-11-05 Eli Zaretskii <eliz@gnu.org> | 9 | 2012-11-05 Eli Zaretskii <eliz@gnu.org> |
| 2 | 10 | ||
| 3 | * display.texi (Auto Scrolling): Clarify that scroll-step is | 11 | * display.texi (Auto Scrolling): Clarify that scroll-step is |
diff --git a/doc/emacs/buffers.texi b/doc/emacs/buffers.texi index dfd8f792300..8c6705cc0c9 100644 --- a/doc/emacs/buffers.texi +++ b/doc/emacs/buffers.texi | |||
| @@ -309,7 +309,7 @@ whose names begin with a space, which are used internally by Emacs. | |||
| 309 | To kill internal buffers as well, call @code{kill-matching-buffers} | 309 | To kill internal buffers as well, call @code{kill-matching-buffers} |
| 310 | with a prefix argument. | 310 | with a prefix argument. |
| 311 | 311 | ||
| 312 | The buffer menu feature is also convenient for killing various | 312 | The Buffer Menu feature is also convenient for killing various |
| 313 | buffers. @xref{Several Buffers}. | 313 | buffers. @xref{Several Buffers}. |
| 314 | 314 | ||
| 315 | @vindex kill-buffer-hook | 315 | @vindex kill-buffer-hook |
| @@ -339,7 +339,7 @@ the Customization buffer to set the variable @code{midnight-mode} to | |||
| 339 | 339 | ||
| 340 | @node Several Buffers | 340 | @node Several Buffers |
| 341 | @section Operating on Several Buffers | 341 | @section Operating on Several Buffers |
| 342 | @cindex buffer menu | 342 | @cindex Buffer Menu |
| 343 | 343 | ||
| 344 | @table @kbd | 344 | @table @kbd |
| 345 | @item M-x buffer-menu | 345 | @item M-x buffer-menu |
| @@ -348,7 +348,7 @@ Begin editing a buffer listing all Emacs buffers. | |||
| 348 | Similar, but do it in another window. | 348 | Similar, but do it in another window. |
| 349 | @end table | 349 | @end table |
| 350 | 350 | ||
| 351 | The @dfn{buffer menu} opened by @kbd{C-x C-b} (@pxref{List Buffers}) | 351 | The @dfn{Buffer Menu} opened by @kbd{C-x C-b} (@pxref{List Buffers}) |
| 352 | does not merely list buffers. It also allows you to perform various | 352 | does not merely list buffers. It also allows you to perform various |
| 353 | operations on buffers, through an interface similar to Dired | 353 | operations on buffers, through an interface similar to Dired |
| 354 | (@pxref{Dired}). You can save buffers, kill them (here called | 354 | (@pxref{Dired}). You can save buffers, kill them (here called |
| @@ -356,106 +356,169 @@ operations on buffers, through an interface similar to Dired | |||
| 356 | 356 | ||
| 357 | @findex buffer-menu | 357 | @findex buffer-menu |
| 358 | @findex buffer-menu-other-window | 358 | @findex buffer-menu-other-window |
| 359 | To use the buffer menu, type @kbd{C-x C-b} and switch to the window | 359 | To use the Buffer Menu, type @kbd{C-x C-b} and switch to the window |
| 360 | displaying the @file{*Buffer List*} buffer. You can also type | 360 | displaying the @file{*Buffer List*} buffer. You can also type |
| 361 | @kbd{M-x buffer-menu} to open the buffer menu in the selected window. | 361 | @kbd{M-x buffer-menu} to open the Buffer Menu in the selected window. |
| 362 | Alternatively, the command @kbd{M-x buffer-menu-other-window} opens | 362 | Alternatively, the command @kbd{M-x buffer-menu-other-window} opens |
| 363 | the buffer menu in another window, and selects that window. | 363 | the Buffer Menu in another window, and selects that window. |
| 364 | 364 | ||
| 365 | The buffer menu is a read-only buffer, and can be changed only | 365 | The Buffer Menu is a read-only buffer, and can be changed only |
| 366 | through the special commands described in this section. The usual | 366 | through the special commands described in this section. The usual |
| 367 | cursor motion commands can be used in this buffer. The | 367 | cursor motion commands can be used in this buffer. The following |
| 368 | following commands apply to the buffer described on the current line: | 368 | commands apply to the buffer described on the current line: |
| 369 | 369 | ||
| 370 | @table @kbd | 370 | @table @kbd |
| 371 | @item d | 371 | @item d |
| 372 | Request to delete (kill) the buffer, then move down. The request | 372 | @findex Buffer-menu-delete |
| 373 | shows as a @samp{D} on the line, before the buffer name. Requested | 373 | @kindex d @r{(Buffer Menu)} |
| 374 | deletions take place when you type the @kbd{x} command. | 374 | Flag the buffer for deletion (killing), then move point to the next |
| 375 | line (@code{Buffer-menu-delete}). The deletion flag is indicated by | ||
| 376 | the character @samp{D} on the line, before the buffer name. The | ||
| 377 | deletion occurs only when you type the @kbd{x} command (see below). | ||
| 378 | |||
| 375 | @item C-d | 379 | @item C-d |
| 376 | Like @kbd{d} but move up afterwards instead of down. | 380 | @findex Buffer-menu-delete-backwards |
| 381 | @kindex C-d @r{(Buffer Menu)} | ||
| 382 | Like @kbd{d}, but move point up instead of down | ||
| 383 | (@code{Buffer-menu-delete-backwards}). | ||
| 384 | |||
| 377 | @item s | 385 | @item s |
| 378 | Request to save the buffer. The request shows as an @samp{S} on the | 386 | @findex Buffer-menu-save |
| 379 | line. Requested saves take place when you type the @kbd{x} command. | 387 | @kindex s @r{(Buffer Menu)} |
| 380 | You may request both saving and deletion for the same buffer. | 388 | Flag the buffer for saving (@code{Buffer-menu-save}). The save flag |
| 389 | is indicated by the character @samp{S} on the line, before the buffer | ||
| 390 | name. The saving occurs only when you type @kbd{x}. You may request | ||
| 391 | both saving and deletion for the same buffer. | ||
| 392 | |||
| 381 | @item x | 393 | @item x |
| 382 | Perform previously requested deletions and saves. | 394 | @findex Buffer-menu-execute |
| 395 | @kindex x @r{(Buffer Menu)} | ||
| 396 | Perform all flagged deletions and saves (@code{Buffer-menu-execute}). | ||
| 397 | |||
| 383 | @item u | 398 | @item u |
| 384 | Remove any request made for the current line, and move down. | 399 | @findex Buffer-menu-unmark |
| 400 | @kindex u @r{(Buffer Menu)} | ||
| 401 | Remove all flags from the current line, and move down | ||
| 402 | (@code{Buffer-menu-unmark}). | ||
| 403 | |||
| 385 | @item @key{DEL} | 404 | @item @key{DEL} |
| 386 | Move to previous line and remove any request made for that line. | 405 | @findex Buffer-menu-backup-unmark |
| 406 | @kindex DEL @r{(Buffer Menu)} | ||
| 407 | Move to the previous line and remove all flags on that line | ||
| 408 | (@code{Buffer-menu-backup-unmark}). | ||
| 387 | @end table | 409 | @end table |
| 388 | 410 | ||
| 389 | The @kbd{d}, @kbd{C-d}, @kbd{s} and @kbd{u} commands to add or remove | 411 | @noindent |
| 390 | flags also move down (or up) one line. They accept a numeric argument | 412 | The commands for adding or removing flags, @kbd{d}, @kbd{C-d}, @kbd{s} |
| 391 | as a repeat count. | 413 | and @kbd{u}, all accept a numeric argument as a repeat count. |
| 392 | 414 | ||
| 393 | These commands operate immediately on the buffer listed on the current | 415 | The following commands operate immediately on the buffer listed on |
| 394 | line: | 416 | the current line. They also accept a numeric argument as a repeat |
| 417 | count. | ||
| 395 | 418 | ||
| 396 | @table @kbd | 419 | @table @kbd |
| 397 | @item ~ | 420 | @item ~ |
| 398 | Mark the buffer ``unmodified''. The command @kbd{~} does this | 421 | @findex Buffer-menu-not-modified |
| 399 | immediately when you type it. | 422 | @kindex ~ @r{(Buffer Menu)} |
| 423 | Mark the buffer as unmodified (@code{Buffer-menu-not-modified}). | ||
| 424 | @xref{Save Commands}. | ||
| 425 | |||
| 400 | @item % | 426 | @item % |
| 401 | Toggle the buffer's read-only flag. The command @kbd{%} does | 427 | @findex Buffer-menu-toggle-read-only |
| 402 | this immediately when you type it. | 428 | @kindex % @r{(Buffer Menu)} |
| 429 | Toggle the buffer's read-only status | ||
| 430 | (@code{Buffer-menu-toggle-read-only}). @xref{Misc Buffer}. | ||
| 431 | |||
| 403 | @item t | 432 | @item t |
| 404 | Visit the buffer as a tags table. @xref{Select Tags Table}. | 433 | @findex Buffer-menu-visit-tags-table |
| 434 | @kindex % @r{(Buffer Menu)} | ||
| 435 | Visit the buffer as a tags table | ||
| 436 | (@code{Buffer-menu-visit-tags-table}). @xref{Select Tags Table}. | ||
| 405 | @end table | 437 | @end table |
| 406 | 438 | ||
| 407 | There are also commands to select another buffer or buffers: | 439 | The following commands are used to select another buffer or buffers: |
| 408 | 440 | ||
| 409 | @table @kbd | 441 | @table @kbd |
| 410 | @item q | 442 | @item q |
| 411 | Quit the buffer menu---immediately display the most recent formerly | 443 | @findex quit-window |
| 412 | visible buffer in its place. | 444 | @kindex q @r{(Buffer Menu)} |
| 445 | Quit the Buffer Menu (@code{quit-window}). The most recent formerly | ||
| 446 | visible buffer is displayed in its place. | ||
| 447 | |||
| 413 | @item @key{RET} | 448 | @item @key{RET} |
| 414 | @itemx f | 449 | @itemx f |
| 415 | Immediately select this line's buffer in place of the @file{*Buffer | 450 | @findex Buffer-menu-this-window |
| 416 | List*} buffer. | 451 | @kindex f @r{(Buffer Menu)} |
| 452 | @kindex RET @r{(Buffer Menu)} | ||
| 453 | Select this line's buffer, replacing the @file{*Buffer List*} buffer | ||
| 454 | in its window (@code{Buffer-menu-this-window}). | ||
| 455 | |||
| 417 | @item o | 456 | @item o |
| 418 | Immediately select this line's buffer in another window as if by | 457 | @findex Buffer-menu-other-window |
| 419 | @kbd{C-x 4 b}, leaving @file{*Buffer List*} visible. | 458 | @kindex o @r{(Buffer Menu)} |
| 459 | Select this line's buffer in another window, as if by @kbd{C-x 4 b}, | ||
| 460 | leaving @file{*Buffer List*} visible | ||
| 461 | (@code{Buffer-menu-other-window}). | ||
| 462 | |||
| 420 | @item C-o | 463 | @item C-o |
| 421 | Immediately display this line's buffer in another window, but don't | 464 | @findex Buffer-menu-switch-other-window |
| 422 | select the window. | 465 | @kindex C-o @r{(Buffer Menu)} |
| 466 | Display this line's buffer in another window, without selecting it | ||
| 467 | (@code{Buffer-menu-switch-other-window}). | ||
| 468 | |||
| 423 | @item 1 | 469 | @item 1 |
| 424 | Immediately select this line's buffer in a full-screen window. | 470 | @findex Buffer-menu-1-window |
| 471 | @kindex 1 @r{(Buffer Menu)} | ||
| 472 | Select this line's buffer in a full-frame window | ||
| 473 | (@code{Buffer-menu-1-window}). | ||
| 474 | |||
| 425 | @item 2 | 475 | @item 2 |
| 426 | Immediately set up two windows, with this line's buffer selected in | 476 | @findex Buffer-menu-2-window |
| 427 | one, and the previously current buffer (aside from the buffer | 477 | @kindex 2 @r{(Buffer Menu)} |
| 428 | @file{*Buffer List*}) displayed in the other. | 478 | Set up two windows on the current frame, with this line's buffer |
| 479 | selected in one, and a previously current buffer (aside from | ||
| 480 | @file{*Buffer List*}) in the other (@code{Buffer-menu-2-window}). | ||
| 481 | |||
| 429 | @item b | 482 | @item b |
| 430 | Bury the buffer listed on this line. | 483 | @findex Buffer-menu-bury |
| 484 | @kindex b @r{(Buffer Menu)} | ||
| 485 | Bury this line's buffer (@code{Buffer-menu-bury}). | ||
| 486 | |||
| 431 | @item m | 487 | @item m |
| 488 | @findex Buffer-menu-mark | ||
| 489 | @kindex m @r{(Buffer Menu)} | ||
| 432 | Mark this line's buffer to be displayed in another window if you exit | 490 | Mark this line's buffer to be displayed in another window if you exit |
| 433 | with the @kbd{v} command. The request shows as a @samp{>} at the | 491 | with the @kbd{v} command (@code{Buffer-menu-mark}). The display flag |
| 434 | beginning of the line. (A single buffer may not have both a delete | 492 | is indicated by the character @samp{>} at the beginning of the line. |
| 435 | request and a display request.) | 493 | (A single buffer may not have both deletion and display flags.) |
| 494 | |||
| 436 | @item v | 495 | @item v |
| 437 | Immediately select this line's buffer, and also display in other windows | 496 | @findex Buffer-menu-select |
| 438 | any buffers previously marked with the @kbd{m} command. If you have not | 497 | @kindex v @r{(Buffer Menu)} |
| 439 | marked any buffers, this command is equivalent to @kbd{1}. | 498 | Select this line's buffer, and also display in other windows any |
| 499 | buffers flagged with the @kbd{m} command (@code{Buffer-menu-select}). | ||
| 500 | If you have not flagged any buffers, this command is equivalent to | ||
| 501 | @kbd{1}. | ||
| 440 | @end table | 502 | @end table |
| 441 | 503 | ||
| 442 | There is also a command that affects the entire buffer list: | 504 | The following commands affect the entire buffer list: |
| 443 | 505 | ||
| 444 | @table @kbd | 506 | @table @kbd |
| 507 | @item S | ||
| 508 | @findex tabulated-list-sort | ||
| 509 | @kindex S @r{(Buffer Menu)} | ||
| 510 | Sort the Buffer Menu entries according to their values in the column | ||
| 511 | at point. With a numeric prefix argument @var{n}, sort according to | ||
| 512 | the @var{n}-th column (@code{tabulated-list-sort}). | ||
| 513 | |||
| 445 | @item T | 514 | @item T |
| 446 | Delete, or reinsert, lines for non-file buffers. This command toggles | 515 | @findex Buffer-menu-toggle-files-only |
| 447 | the inclusion of such buffers in the buffer list. | 516 | @kindex T @r{(Buffer Menu)} |
| 517 | Delete, or reinsert, lines for non-file buffers | ||
| 518 | @code{Buffer-menu-toggle-files-only}). This command toggles the | ||
| 519 | inclusion of such buffers in the buffer list. | ||
| 448 | @end table | 520 | @end table |
| 449 | 521 | ||
| 450 | What @code{buffer-menu} actually does is create and switch to a | ||
| 451 | suitable buffer, and turn on Buffer Menu mode in it. Everything else | ||
| 452 | described above is implemented by the special commands provided in | ||
| 453 | Buffer Menu mode. One consequence of this is that you can switch from | ||
| 454 | the @file{*Buffer List*} buffer to another Emacs buffer, and edit | ||
| 455 | there. You can reselect the @file{*Buffer List*} buffer later, to | ||
| 456 | perform the operations already requested, or you can kill it, or pay | ||
| 457 | no further attention to it. | ||
| 458 | |||
| 459 | Normally, the buffer @file{*Buffer List*} is not updated | 522 | Normally, the buffer @file{*Buffer List*} is not updated |
| 460 | automatically when buffers are created and killed; its contents are | 523 | automatically when buffers are created and killed; its contents are |
| 461 | just text. If you have created, deleted or renamed buffers, the way | 524 | just text. If you have created, deleted or renamed buffers, the way |
| @@ -633,7 +696,6 @@ C-b}. To customize this buffer list, use the @code{bs} Custom group | |||
| 633 | @findex msb-mode | 696 | @findex msb-mode |
| 634 | @cindex mode, MSB | 697 | @cindex mode, MSB |
| 635 | @cindex MSB mode | 698 | @cindex MSB mode |
| 636 | @cindex buffer menu | ||
| 637 | @findex mouse-buffer-menu | 699 | @findex mouse-buffer-menu |
| 638 | @kindex C-Down-Mouse-1 | 700 | @kindex C-Down-Mouse-1 |
| 639 | MSB global minor mode (``MSB'' stands for ``mouse select buffer'') | 701 | MSB global minor mode (``MSB'' stands for ``mouse select buffer'') |
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index fc99ff3d7bf..42e2a6ea8ff 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi | |||
| @@ -275,7 +275,7 @@ will disappear from the mode line. That means you can safely go on | |||
| 275 | editing in the same Emacs session. | 275 | editing in the same Emacs session. |
| 276 | 276 | ||
| 277 | Do not use @kbd{M-x buffer-menu} to save or kill buffers when you run | 277 | Do not use @kbd{M-x buffer-menu} to save or kill buffers when you run |
| 278 | out of memory, because the buffer menu needs a fair amount of memory | 278 | out of memory, because the Buffer Menu needs a fair amount of memory |
| 279 | itself, and the reserve supply may not be enough. | 279 | itself, and the reserve supply may not be enough. |
| 280 | 280 | ||
| 281 | @node Crashing | 281 | @node Crashing |