Next: Install and first steps, Previous: (dir), Up: (dir) [Contents][Index]
This is the user manual for ECB version 2.40.
ECB stands for "Emacs Code Browser". While (X)Emacs already has good editing support for many modes, its browsing support is somewhat lacking. That’s where ECB comes in: it displays a number of informational windows that allow for easy source code navigation and overview.
The informational windows can contain:
As an added bonus, ECB makes sure to keep these informational windows visible, even when you use C-x 1 and similar commands.
It goes without saying that you can configure the layout, ie which informational windows should be displayed where. ECB comes with a number of ready-made window layouts to choose from.
Please note: Experienced ECB users find a complete alphabetical list of all commands and user-options in Interactive ECB commands and Customizable options.
The latest version of ECB can always be found at http://ecb.sourceforge.net
To send bug reports, or participate in discussions about ECB, use the mailing list ecb-list@lists.sourceforge.net via http://lists.sourceforge.net/lists/listinfo/ecb-list
IMPORTANT: Cause of extra appearance of SPAM in the mailing-lists, SourceForge has changed its policy: Now it is only possible to post to the mailing-list for users who have subscribed this mailing-list. So please be aware you will not be able to send comments, bug reports and improvement suggestions before you have subscribed the ECB-mailing-list. See the section "Mailing-list" at the ECB-website at http://ecb.sourceforge.net how to do this.
• Install and first steps: | Installing ECB and first steps | |
• Overview: | Compact introducing of basic concepts | |
• Manual usage: | How to use this manual | |
• ECB-windows: | Description of all ECB-windows of ECB | |
• Activation and Deactivation: | How to start and end ECB | |
• Usage of ECB: | How to use ECB | |
• Customizing: | How to customize ECB | |
• Submitting problem report: | What to do when problems occur | |
• Upgrading: | Upgrading and downloading packages | |
• Common use-cases: | Useful hints and tips | |
• Elisp programming: | Entry points for Elisp programmers | |
• Conflicts and bugs: | Known Conflicts with other packages and bugs | |
• FAQ: | Frequently asked questions | |
• Command Index: | Index for interactive commands | |
• Option Index: | Index for user options | |
• Concept Index: | Index for concepts and terms | |
— The Detailed Node Listing — Installation and first steps of ECB | ||
---|---|---|
• Installation: | Installation of ECB | |
• Setting up Emacs: | How to set up Emacs for file parsing with ECB | |
• First steps: | First steps after activating ECB first time | |
Installation of ECB | ||
• Requirements: | Requirements for ECB | |
• ECB as XEmacs-package: | Installation of ECB as a XEmacs-package | |
• Standard ECB-Installation: | Standard installation of ECB for (X)Emacs | |
How to set up Emacs for file parsing with ECB | ||
• General hints: | General hints for a correct setup | |
• Setting up CEDET/semantic: | How to setup semantic correctly | |
• Non-semantic files: | Setup for file types not supported by semantic | |
All ECB-windows of ECB | ||
• Basic ECB-windows: | Description of the basic ECB-windows | |
• Add-on ECB-windows: | Description of additional ECB-windows | |
The basic ECB-windows of ECB | ||
• Tree-buffer basics: | General introduction into tree-buffers | |
• Tree-buffer styles: | Displaying the trees with different styles | |
• ECB Directories-window: | Contents of the ECB Directories-window | |
• ECB Sources-window: | Contents of the ECB Sources-window | |
• ECB Methods-window: | Contents of the ECB Methods-window | |
• ECB History-window: | Contents of the ECB History-window | |
Displaying the trees with different styles | ||
• Style basics: | Basic knowledge about the styles | |
• Ascii-based styles: | How to customize the ascii-styles | |
• Tree-buffers with images: | Which images are used for the tree | |
• Images for Methods-buffer: | Images for the tags in the Methods-buffer | |
Add-on ECB-windows of ECB | ||
• Semantic analyser: | Analyses and displays semantic context | |
• Symboldefinition: | Displays definition of current symbol | |
Activation and Deactivation | ||
• Standard activation: | How to manually (de)activate ECB | |
• Automatic activation: | Automatically (de)activating ECB | |
Usage of ECB | ||
• Using the mouse: | Working with the mouse | |
• Using the keyboard: | Working with the keyboard | |
• The edit-area: | How to use the edit-area | |
• Temp- and compile-buffers: | Displaying temp- and compilation-buffers | |
• The other window: | How the “other window” is determined | |
• The Methods window: | Using and customizing the Methods-window | |
• Filtering the tree-buffers: | Applying filters to the ECB-tree-buffers | |
• The ECB-layout: | Changing, customizing, redrawing, creating | |
• Hiding the ECB windows: | Hiding/Showing the ECB-windows | |
• Maximizing the ECB windows: | Maximizing the ECB-windows | |
• Back/forward navigation: | Back- and forward navigation like a browser | |
• ECB-window synchronizing: | Auto./manual synchronizing the ECB-windows | |
• Stealthy background tasks: | Stealthy background-tasks of ECB | |
• Interactive ECB commands: | All interactive user-commands of ECB | |
Working with the keyboard in the ECB-windows | ||
• Navigation/Selection: | Keyboard navigation/selection in a tree-buffer | |
• Incremental search: | Find nodes as fast as possible | |
• Personal tree-keybindings: | Adding personal keybindings to a tree-buffer | |
• Using popup-menus: | Using the popup-menus from keyboard. | |
Using and customizing the ECB-Methods window | ||
• Visiting tags: | Possible actions after visiting a tag | |
• Expanding: | Explicit and automatic expanding | |
• Customizing the display: | How to customize the Methods-buffer display | |
• Updating Methods-window: | Updating Methods with contents of current buffer | |
• Updating for ind. buffers: | Updating Methods for indirect buffers | |
• Jumping to external tags: | Jumping to the definition of external types | |
Applying filters to the special ECB-tree-buffers | ||
• Filtering Directories: | Applying filters to the Directories-buffer | |
• Filtering Sources: | Applying filters to the Sources–buffer | |
• Filtering History: | Applying filters to the History-buffer | |
• Filtering Methods: | Applying filters to the Methods-buffer | |
Changing, customizing, redrawing and creating layouts | ||
• Changing the ECB-layout: | How to change and customize the layout | |
• Redrawing the ECB-layout: | How and when redrawing the layout | |
• Changing window sizes: | Changing sizes of the ECB-windows | |
• Fixing window sizes: | Fixing sizes of the ECB-windows | |
• Creating a new ECB-layout: | Interactively creating new layouts | |
Synchronization of the ECB-windows | ||
• General synchronization aspects: | General synchronization aspects | |
• Synchronization of basic ECB-windows: | Synchronization of basic ECB-windows | |
• Add-on synchronization: | Synchronization of add-on ECB-windows | |
Customizing ECB | ||
• General aspects: | General aspects for customizing ECB | |
• Most important options: | Which option you must know | |
• Customizable options: | All customizable options of ECB | |
General aspects for customizing ECB | ||
• setq or customize: | Should i use setq or customize? | |
• Site-wide customizing: | Site-wide customizing of ECB | |
All customizable options of ECB | ||
• ecb-general: | General customizing ECB | |
• ecb-tree-buffer: | Customizing the general tree layout | |
• ecb-directories: | Customizing the ECB-directories-tree | |
• ecb-sources: | Customizing the ECB-sources-window | |
• ecb-methods: | Customizing the ECB-methods-window | |
• ecb-history: | Customizing the ECB-history-window | |
• ecb-analyse: | Customizing the ECB-analyse-window | |
• ecb-symboldef: | Customizing the ECB-symboldef-window | |
• ecb-layout: | Customizing the ECB-layout | |
• ecb-compilation: | Customizing the compile-window | |
• ecb-create-layout: | Customizing options for creating layouts | |
• ecb-face-options: | Customizing options for faces | |
• ecb-faces: | Customizing the faces | |
• ecb-help: | Customizing the online help of ECB | |
• ecb-eshell: | Customizing the eshell-integration | |
• ecb-speedbar: | Customizing the speedbar-integration | |
• ecb-non-semantic: | Customizing parsing non-semantic sources | |
• ecb-winman: | Customizing window-manager support | |
• ecb-mode-line: | Customizing the tree-buffer-modelines | |
• ecb-version-control: | Customizing the version-control-support | |
Upgrading and downloading packages | ||
• Downloading new versions: | How to download newer versions of packages | |
• Auto. option-upgrading: | ECB can auto. upgrade your options | |
Automatic upgrading of options | ||
• User interface: | Options and commands you should know | |
• Background information: | Maybe some interesting informations | |
Handling of common use-cases | ||
• Changing faces: | Changing faces in the ECB tree-buffers | |
• Small screens: | Working with small screens | |
• Big screens: | Working with big screens | |
• Simulating speedbar: | Simulating speedbar without an extra frame | |
• Integrating speedbar: | Integrating speedbar in the ECB-frame | |
• Large directories: | Working with large directories | |
• Remote directories: | Working with remote directories | |
• Version-control support: | Supporting Version control systems | |
• Using eshell: | Optimal using of eshell in ECB | |
• Grepping directories: | Grepping directories with ECB | |
• Working with JDEE: | Working best with ECB and JDEE | |
• Compile-window on demand: | Displaying the compile-window on demand | |
• Non-semantic sources: | Parsing and displaying non-semantic sources | |
• Hide-show: | Using hide-show from the methods-buffer-menu | |
• Window-managers and ECB: | Support of several Emacs-window-managers | |
• Virtual folders in History: | Simulating something like virtual folders | |
Supporting Version control systems | ||
• Identifying backends: | How ECB identifies the VC-backend of a dir | |
• Checking the state: | How ECB checks the VC-state of a file | |
• Remote repositories: | What you should know about this | |
• Refreshing the VC-state: | How to refresh when state changed outside | |
• Adding new backends: | Necessary steps for adding new backends | |
• Known VC-problems: | Currently known problems of the VC-support | |
Entry points for Elisp programmers | ||
• List of variables: | Which variables an Elisp-program can use | |
• List of hooks: | All available hooks | |
• tree-buffer: | Full description of the tree-buffer-library | |
• Adviced functions: | How to deal with the adviced functions | |
• The layout-engine: | Programming new layouts and special windows | |
The library tree-buffer.el | ||
• Introduction: | General description of tree-buffers | |
• A new tree-buffer: | How to create a new tree-buffer | |
• A new tree-node: | How to add new tree-nodes to a tree-buffer | |
• Updating a tree-buffer: | How to update a tree-buffer after changes | |
• Tree-buffer keybindings: | Default and customizable keybindings | |
• The tree-buffer-API: | All functions for tree-buffers and -nodes | |
• Do not with tree-buffer: | Things which are strictly forbidden | |
• Tree-buffer How to: | Dealing with special situations | |
How to program new layouts and new special windows | ||
• Programming a new layout: | How to program a new layout | |
• Programming special windows: | Aspects of programming special windows | |
• Possible layout-outlines: | The wide range of possible layouts | |
• The layout-engine API: | The complete layout-engine API | |
Conflicts and bugs of ECB | ||
• Conflicts: | Conflicts with other packages | |
• Bugs: | Known bugs | |
Next: Install and first steps, Previous: (dir), Up: (dir) [Contents][Index]