Table of Contents

1. Installation and first steps of ECB

1.1 Installation of ECB

1.1.1 Installation of ECB for XEmacs users
1.1.2 Installation of ECB for GNU Emacs users

1.2 How to set up Emacs for file parsing with ECB

1.2.1 General hints for a correct setup
1.2.2 Setting up semantic
1.2.3 Setup for file types not supported by semantic

1.3 First steps after activating ECB first time

2. Overview

2.1 ECB Directories-buffer
2.2 ECB Sources-buffer
2.3 ECB Methods-buffer

3. Activation and Deactivation

3.1 Standard activation and deactivation
3.2 Automatic activation and deactivation

4. Usage of ECB

4.1 Working with the mouse in the ECB-windows

4.1.1 The primary mouse-button
4.1.2 The POWER- or SHIFT-click
4.1.3 The secondary mouse-button
4.1.4 The right mouse-button
4.1.5 Horizontal scrolling with the mouse

4.2 Working with the keyboard in the ECB-windows

4.2.1 Navigation and Selection in a tree-buffer
4.2.2 Incremental search for a node in current tree-buffer
4.2.3 Adding personal keybindings
4.2.4 Using the popup-menu of a tree-buffer from keyboard.

4.3 Working with the edit-window(s) of the edit-area

4.3.1 Documentation of the adviced window functions

4.4 Temp- and compile-buffers display in ECB

4.4.1 Standard Emacs behavior
4.4.2 Using a durable compile window
4.4.3 What to do if there are problems with the compile-window
4.4.4 Handling special-display-buffers

4.5 How the "other window" is determined by ECB

4.5.1 "Other window"-basics in ECB
4.5.2 Builtin "other window" behaviors of ECB
4.5.3 User-defined "other window" behavior

4.6 Using and customizing the ECB-Methods buffer

4.6.1 Possible actions after visiting a tag
4.6.2 Explicit and automatic expanding of the ECB-methods-buffer

4.6.2.1 Explicit expanding all nodes to a certain expansion level
4.6.2.2 Explicit expanding of the current node to a certain level
4.6.2.3 Automatic expansion ot tags after buffer-parsing
4.6.2.4 Automatic expanding the ECB-methods-buffer for current tag

4.6.3 Customizing the display of the Methods-buffer
4.6.4 Rebuilding the Methods-buffer

4.7 Applying filters to the special ECB-tree-buffers

4.7.1 Applying filters to the Directories-buffer
4.7.2 Applying filters to the Sources-buffer

4.7.2.1 Interactive Sources-filters
4.7.2.2 Default Sources-filters

4.7.3 Applying filters to the History-buffer

4.7.3.1 Interactive History-filters
4.7.3.2 Default History-filters

4.7.4 Applying filters to the Methods-buffer

4.7.4.1 Possible filter-criterias
4.7.4.2 Inverse Filters
4.7.4.3 Layered filters
4.7.4.4 Display of currently applied filters
4.7.4.5 Default filters for certain files.

4.8 Changing, customizing, redrawing and creating layouts

4.8.1 Changing and customizing the ECB-layout
4.8.2 Redrawing the ECB-layout
4.8.3 Changing the sizes of the special ECB-windows
4.8.4 Fixing the sizes of the special ECB-windows
4.8.5 Interactively creating new layouts

4.9 Hiding/Showing the ECB windows
4.10 Maximizing the ECB windows
4.11 Back- and forward navigation like a browser
4.12 Synchronization of the ECB-windows
4.13 Stealthy background-tasks of ECB
4.14 Interactive ECB commands

5. Customizing ECB

5.1 General aspects for customizing ECB

5.1.1 Setq or customize - what should i use?
5.1.2 Site-wide customizing of ECB

5.1.2.1 Storing all option-settings in the users custom-file
5.1.2.2 Using a special setq for site-wide settings

5.2 The most important options of ECB
5.3 All customizable options of ECB

5.3.1 Group ecb-general
5.3.2 Group ecb-tree-buffer
5.3.3 Group ecb-directories
5.3.4 Group ecb-sources
5.3.5 Group ecb-methods
5.3.6 Group ecb-history
5.3.7 Group ecb-layout
5.3.8 Group ecb-compilation
5.3.9 Group ecb-create-layout
5.3.10 Group ecb-face-options
5.3.11 Group ecb-faces
5.3.12 Group ecb-download
5.3.13 Group ecb-help
5.3.14 Group ecb-eshell
5.3.15 Group ecb-speedbar
5.3.16 Group ecb-non-semantic
5.3.17 Group ecb-winman
5.3.18 Group ecb-mode-line
5.3.19 Group ecb-version-control

6. Submitting a problem report
7. Upgrading and downloading packages

7.1 Downloading new versions of ECB and/or required packages
7.2 Automatic upgrading of options

7.2.1 User interface for option-upgrading
7.2.2 Background information

8. Tips and tricks

8.1 Changing faces in the ECB tree-buffers
8.2 Working with small screens
8.3 Working with big screens
8.4 Simulating speedbar without an extra frame
8.5 Integrating speedbar in the ECB-frame
8.6 Optimize scrolling in the edit-window
8.7 Working with large directories
8.8 Working with remote directories

8.8.1 General remarks
8.8.2 Excluding remote directories from time-consuming tasks
8.8.3 Caching the contents of remote directories

8.9 Supporting Version control systems

8.9.1 How ECB identifies the VC-backend of a dir

8.9.1.1 Special remarks for XEmacs

8.9.2 How ECB checks the VC-state of a file

8.9.2.1 Getting heuristic state-values or real ones for CVS

8.9.3 Important informations about remote repositories

8.9.3.1 Remote paths and the VC-support of ECB

8.9.4 How to refresh ECB-state-display when changed outside
8.9.5 Necessary steps and informations for adding new backends
8.9.6 Currently know problems with the VC-support

8.9.6.1 Remote repositories and XEmacs

8.10 Optimal using of eshell in ECB
8.11 Grepping directories with ECB
8.12 Working best with ECB and JDEE
8.13 Displaying the compile-window on demand
8.14 Parsing and displaying non-semantic sources

8.14.1 Enabling parsing and displaying of non-semantic-sources
8.14.2 Automatic rescanning/reparsing of non-semantic-sources
8.14.3 Customizing the display of the tags

8.15 Using hide-show from the methods-buffer-menu
8.16 Support of several Emacs-window-managers

8.16.1 Enabling of the support
8.16.2 Usage of a window-manager in combination with ECB
8.16.3 Disabling the support

8.17 Displaying the trees of the ECB-windows with different styles

8.17.1 Basic knowledge about the styles
8.17.2 How to customize the ascii-styles
8.17.3 Which images are used for the tree

8.17.3.1 A special note for XEmacs

8.17.4 Special images for the Methods-buffer

8.18 Using semanticdb to jump to type-tags defined in other files

9. Entry points for Elisp programmers

9.1 Variables for Elisp-programs
9.2 Available hooks of ECB
9.3 The library tree-buffer.el
9.4 How to deal with the adviced window-functions
9.5 How to program new layouts and new special windows

9.5.1 How to program a new layout
9.5.2 All aspects of programming special windows

9.5.2.1 The outline of the example layout:
9.5.2.2 The description of the layout-contents
9.5.2.3 The example code
9.5.2.4 The bufferinfo buffer of the example
9.5.2.5 The action buffer of the example
9.5.2.6 Adding the bufferinfo- and action-buffer to a new layout
9.5.2.7 Synchronizing the bufferinfo-buffer automatically
9.5.2.8 Activating and deactivating new layouts

9.5.3 The wide range of possible layout-outlines
9.5.4 The complete layout-engine API of ECB

10. Conflicts and bugs of ECB

10.1 Conflicts with other packages

10.1.1 Proved workarounds or recommendations for other packages

10.1.1.1 Package avoid.el
10.1.1.2 Package bs.el
10.1.1.3 Package BBDB
10.1.1.4 Package calendar.el
10.1.1.5 Package cygwin-mount.el
10.1.1.6 Package desktop.el
10.1.1.7 Package edebug (Lisp Debugger)
10.1.1.8 Package ediff.el
10.1.1.9 Package follow-mouse.el
10.1.1.10 Package func-menu.el
10.1.1.11 Package Gnus (Newsreader)
10.1.1.12 Package JDEE (Java Development Environment)
10.1.1.13 Package scroll-all.el (scroll-all-mode)
10.1.1.14 Package VC (Version Control)
10.1.1.15 Package VM (Emacs Mail-Client)
10.1.1.16 Package winner.el (winner-mode)
10.1.1.17 Package wb-line-number.el
10.1.1.18 Application xrefactory

10.1.2 What to do for unknown conflicts with other packages

10.2 Known bugs

10.2.1 Following the source-file link in a help-buffer
10.2.2 Extra history-entries for JDEE source-buffers

11. Frequently asked questions
Command Index
Option Index
Concept Index