aboutsummaryrefslogtreecommitdiffstats
path: root/man/frames.texi
diff options
context:
space:
mode:
Diffstat (limited to 'man/frames.texi')
-rw-r--r--man/frames.texi67
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,
545the variable should be @code{nil}. 545the 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)
552that serves as a scrollable menu of files you could visit and tags 552 The @dfn{speedbar} is a special frame for conveniently navigating in
553within those files. To create a speedbar, type @kbd{M-x speedbar}; this 553or operating on another frame. The speedbar, when it exists, is
554creates a speedbar window for the selected frame. From then on, you can 554always associated with a specific frame, called its @dfn{attached
555click on a file name in the speedbar to visit that file in the 555frame}; all speedbar operations act on that frame.
556corresponding Emacs frame, or click on a tag name to jump to that tag in 556
557the Emacs frame. 557 Type @kbd{M-x speedbar} to create the speedbar and associate it with
558 558the current frame. To dismiss the speedbar, type @kbd{M-x speedbar}
559 Initially the speedbar lists the immediate contents of the current 559again, or select the speedbar and type @kbd{q}. (You can also delete
560directory, one file per line. Each line also has a box, @samp{[+]} or 560the 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 561associate the speedbar with a different frame, dismiss it and call
562contents 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
566directory of the selected window of the attached frame, one file per
567line. Clicking on a file name visits that file in the selected window
568of the attached frame, and clicking on a directory name shows that
569directory in the speedbar (@pxref{Mouse References}). Each line also
570has a box, @samp{[+]} or @samp{<+>}, that you can click on to
571@dfn{expand} the contents of that item. Expanding a directory adds
563the contents of that directory to the speedbar display, underneath the 572the contents of that directory to the speedbar display, underneath the
564directory's own line. If the line lists an ordinary file, opening it up 573directory's own line. Expanding an ordinary file adds a list of the
565adds a list of the tags in that file to the speedbar display. When a 574tags in that file to the speedbar display; you can click on a tag name
566file is opened up, the @samp{[+]} changes to @samp{[-]}; you can click 575to jump to that tag in the selected window of the attached frame.
567on that box to ``close up'' that file (hide its contents). 576When a file or directory is expanded, the @samp{[+]} changes to
577@samp{[-]}; you can click on that box to @dfn{contract} the item,
578hiding 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
582clicking the item on the current line, and @kbd{SPC} expands or
583contracts the item. @kbd{U} displays the parent directory of the
584current directory. To copy, delete, or rename the file on the current
585line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively. To create a
586new directory, type @kbd{M}.
587
588 Another general-purpose speedbar mode is @dfn{Buffer Display} mode;
589in this mode, the speedbar displays a list of Emacs buffers. To
590switch to this mode, type @kbd{b} in the speedbar. To return to File
591Display mode, type @kbd{f}. You can also change the display mode by
592clicking @kbd{mouse-3} anywhere in the speedbar window (or
593@kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the
594pop-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
570specialized ways of putting useful items into the speedbar for you to 597specialized 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
572files, and lets you move the current message to another Rmail file by 599files, and lets you move the current message to another Rmail file by
573clicking on its @samp{<M>} box. 600clicking 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,
576frame. If you use multiple frames, you can make a speedbar for some or 603Speedbar,,speedbar, Speedbar Manual}.
577all of the frames; type @kbd{M-x speedbar} in any given frame to make a
578speedbar for it.
579 604
580@node Multiple Displays 605@node Multiple Displays
581@section Multiple Displays 606@section Multiple Displays