Speedbar is a program for Emacs which can be used to summarize information related to the current buffer. Its original inspiration is the “explorer” often used in modern development environments, office packages, and web browsers.
Speedbar displays a narrow frame in which a tree view is shown. This tree view defaults to containing a list of files and directories. Files can be “expanded” to list tags inside. Directories can be expanded to list the files within itself. Each file or tag can be jumped to immediately.
Speedbar expands upon “explorer” windows by maintaining context with the user. For example, when using the file view, the current buffer's file is highlighted. Speedbar also mimics the explorer windows by providing multiple display modes. These modes come in two flavors. Major display modes remain consistent across buffers, and minor display modes appear only when a buffer of the applicable type is shown. This allows authors of other packages to provide speedbar summaries customized to the needs of that mode.
Throughout this manual, activities are defined as “clicking on”, or “expanding” items. Clicking means using mouse-2 on a button. Expanding refers to clicking on an expansion button to display an expanded summary of the entry the expansion button is on. See Basic Navigation.
|Introduction||Basics of speedbar.|
|Basic Navigation||Basics of speedbar common between all modes.|
|File Mode||Summarizing files.|
|Buffer Mode||Summarizing buffers.|
|Minor Modes||Additional minor modes such as Info and RMAIL.|
|Customizing||Changing speedbar behavior.|
|Extending||Extend speedbar for your own project.|
|GNU Free Documentation License||The license for this documentation.|
Copyright © 1999–2017 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover Texts being “A GNU Manual”, and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License”.
(a) The FSF's Back-Cover Text is: “You have the freedom to copy and modify this GNU manual.”