Difference between revisions of "Emacs Code Browser"

From WikEmacs
Jump to: navigation, search
(added basic ECB page)
 
(Basic setup)
 
(2 intermediate revisions by the same user not shown)
Line 26: Line 26:
 
= Basic setup =
 
= Basic setup =
  
<source lang="lisp">
+
The easiest way to install ECB is using [[Elpa]].
</source>
+
 
 +
To start ECB: {{Command|ecb-activate}}
  
 
= Helpful keybindings =
 
= Helpful keybindings =
 +
 +
== Navigating ==
 +
 +
* {{Keys|C-c . g h}} : Go to history
 +
* {{Keys|C-c . g m}} : Go to methods
 +
* {{Keys|C-c . g s}} : Go to sources:
 +
* {{Keys|C-c . g d}} : Go to directories
 +
* {{Keys|C-c . g 1}} : Main buffer
  
 
= Common Customization =
 
= Common Customization =
Line 41: Line 50:
  
 
[[Category:Project Management]][[Category:Convenience]][[Category:Third Party Package]]
 
[[Category:Project Management]][[Category:Convenience]][[Category:Third Party Package]]
 +
[[Category:Programming]]

Latest revision as of 03:13, 19 October 2013

Emacs Code Browser
Description code navigation tool
Author name of author
Maintainer Klaus Berndl
Source http://ecb.sourceforge.net/

While Emacs already has good editing support for many modes, its browsing support is somewhat lacking. That's where the Emacs Code Browser (ECB) comes in: it displays a number of informational windows that allow for easy source code navigation and overview.

The informational windows can contain:

  • A directory tree,
  • a list of source files in the current directory,
  • a list of functions/classes/methods/... in the current file, (ECB uses the Semantic Bovinator, or Imenu, or etags, for getting this list so all languages supported by any of these tools are automatically supported by ECB too)
  • a history of recently visited files,
  • the Speedbar and
  • output from compilation (the "compilation" window) and other modes like help, grep etc. or whatever a user defines to be displayed in this window.

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.

Basic setup[edit]

The easiest way to install ECB is using Elpa.

To start ECB: M-x ecb-activate

Helpful keybindings[edit]

Navigating[edit]

  • [C-c . g h] : Go to history
  • [C-c . g m] : Go to methods
  • [C-c . g s] : Go to sources:
  • [C-c . g d] : Go to directories
  • [C-c . g 1] : Main buffer

Common Customization[edit]

See Also[edit]

Project Pages[edit]

Tutorial Pages[edit]