diff options
Diffstat (limited to 'man/frames.texi')
| -rw-r--r-- | man/frames.texi | 67 |
1 files changed, 46 insertions, 21 deletions
diff --git a/man/frames.texi b/man/frames.texi index 2928aa7a62a..daaa9599bf7 100644 --- a/man/frames.texi +++ b/man/frames.texi | |||
| @@ -545,26 +545,53 @@ selects it, that variable should be @code{t}; if a click is necessary, | |||
| 545 | the variable should be @code{nil}. | 545 | the variable should be @code{nil}. |
| 546 | 546 | ||
| 547 | @node Speedbar | 547 | @node Speedbar |
| 548 | @section Making and Using a Speedbar Frame | 548 | @section Speedbar Frames |
| 549 | @cindex speedbar | 549 | @cindex speedbar |
| 550 | 550 | ||
| 551 | An Emacs frame can have a @dfn{speedbar}, which is a vertical window | 551 | @cindex attached frame (of speedbar) |
| 552 | that serves as a scrollable menu of files you could visit and tags | 552 | The @dfn{speedbar} is a special frame for conveniently navigating in |
| 553 | within those files. To create a speedbar, type @kbd{M-x speedbar}; this | 553 | or operating on another frame. The speedbar, when it exists, is |
| 554 | creates a speedbar window for the selected frame. From then on, you can | 554 | always associated with a specific frame, called its @dfn{attached |
| 555 | click on a file name in the speedbar to visit that file in the | 555 | frame}; all speedbar operations act on that frame. |
| 556 | corresponding Emacs frame, or click on a tag name to jump to that tag in | 556 | |
| 557 | the Emacs frame. | 557 | Type @kbd{M-x speedbar} to create the speedbar and associate it with |
| 558 | 558 | the current frame. To dismiss the speedbar, type @kbd{M-x speedbar} | |
| 559 | Initially the speedbar lists the immediate contents of the current | 559 | again, or select the speedbar and type @kbd{q}. (You can also delete |
| 560 | directory, one file per line. Each line also has a box, @samp{[+]} or | 560 | the speedbar frame like any other Emacs frame.) If you wish to |
| 561 | @samp{<+>}, that you can click on with @kbd{Mouse-2} to ``open up'' the | 561 | associate the speedbar with a different frame, dismiss it and call |
| 562 | contents of that item. If the line names a directory, opening it adds | 562 | @kbd{M-x speedbar} from that frame. |
| 563 | |||
| 564 | The speedbar can operate in various modes. Its default mode is | ||
| 565 | @dfn{File Display} mode, which shows the files in the current | ||
| 566 | directory of the selected window of the attached frame, one file per | ||
| 567 | line. Clicking on a file name visits that file in the selected window | ||
| 568 | of the attached frame, and clicking on a directory name shows that | ||
| 569 | directory in the speedbar (@pxref{Mouse References}). Each line also | ||
| 570 | has a box, @samp{[+]} or @samp{<+>}, that you can click on to | ||
| 571 | @dfn{expand} the contents of that item. Expanding a directory adds | ||
| 563 | the contents of that directory to the speedbar display, underneath the | 572 | the contents of that directory to the speedbar display, underneath the |
| 564 | directory's own line. If the line lists an ordinary file, opening it up | 573 | directory's own line. Expanding an ordinary file adds a list of the |
| 565 | adds a list of the tags in that file to the speedbar display. When a | 574 | tags in that file to the speedbar display; you can click on a tag name |
| 566 | file is opened up, the @samp{[+]} changes to @samp{[-]}; you can click | 575 | to jump to that tag in the selected window of the attached frame. |
| 567 | on that box to ``close up'' that file (hide its contents). | 576 | When a file or directory is expanded, the @samp{[+]} changes to |
| 577 | @samp{[-]}; you can click on that box to @dfn{contract} the item, | ||
| 578 | hiding its contents. | ||
| 579 | |||
| 580 | You navigate through the speedbar using the keyboard, too. Typing | ||
| 581 | @kbd{RET} while point is on a line in the speedbar is equivalent to | ||
| 582 | clicking the item on the current line, and @kbd{SPC} expands or | ||
| 583 | contracts the item. @kbd{U} displays the parent directory of the | ||
| 584 | current directory. To copy, delete, or rename the file on the current | ||
| 585 | line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively. To create a | ||
| 586 | new directory, type @kbd{M}. | ||
| 587 | |||
| 588 | Another general-purpose speedbar mode is @dfn{Buffer Display} mode; | ||
| 589 | in this mode, the speedbar displays a list of Emacs buffers. To | ||
| 590 | switch to this mode, type @kbd{b} in the speedbar. To return to File | ||
| 591 | Display mode, type @kbd{f}. You can also change the display mode by | ||
| 592 | clicking @kbd{mouse-3} anywhere in the speedbar window (or | ||
| 593 | @kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the | ||
| 594 | pop-up menu. | ||
| 568 | 595 | ||
| 569 | Some major modes, including Rmail mode, Info, and GUD, have | 596 | Some major modes, including Rmail mode, Info, and GUD, have |
| 570 | specialized ways of putting useful items into the speedbar for you to | 597 | specialized ways of putting useful items into the speedbar for you to |
| @@ -572,10 +599,8 @@ select. For example, in Rmail mode, the speedbar shows a list of Rmail | |||
| 572 | files, and lets you move the current message to another Rmail file by | 599 | files, and lets you move the current message to another Rmail file by |
| 573 | clicking on its @samp{<M>} box. | 600 | clicking on its @samp{<M>} box. |
| 574 | 601 | ||
| 575 | A speedbar belongs to one Emacs frame, and always operates on that | 602 | For more details on using and programming the speedbar, @xref{Top, |
| 576 | frame. If you use multiple frames, you can make a speedbar for some or | 603 | Speedbar,,speedbar, Speedbar Manual}. |
| 577 | all of the frames; type @kbd{M-x speedbar} in any given frame to make a | ||
| 578 | speedbar for it. | ||
| 579 | 604 | ||
| 580 | @node Multiple Displays | 605 | @node Multiple Displays |
| 581 | @section Multiple Displays | 606 | @section Multiple Displays |